ドキュメントを書くのは、エージェント。正しく保つのは、あなた。

整形されたドキュメントフォルダ

ドキュメントのフォルダをDotMDにドラッグすると、それがワークスペースになります。ページはタブで開き、サイドバーにはファイル名ではなくタイトルで並びます。タイトルは、ページのfront matterのtitle:フィールドから、なければ最初の見出しから取られます。プロパティは、ページの上にカードとして表示されます。

⇧⌘Fは、ワークスペース内のすべてのフォルダを横断して、ファイル名とすべての行のテキストを検索します。ある設定に触れているページも、1秒で見つかります。

Macでのdocs as code

ドキュメントがMarkdownファイルとしてコードの隣のGitリポジトリにある（docs as code）なら、DotMDがそのフォルダにMac用のリーダーとレビューツールを提供します。リポジトリのドキュメントフォルダをワークスペースとして開き、各ページをレンダリングした状態で読めます。コメントはファイルではなくDotMDが保管するので、コミットに混ざることはありません。エージェントの変更は.mdファイルへの通常の編集で、いつものdiffとプルリクエストにそのまま使えます。

エージェントの下書きをレビューする

1. ページをファイルで頼む

   「インストールガイドをdocs/install.mdに書いて、レビュー用にDotMDで送って」

2. 問題ごとにコメントする

   間違ったコマンドやわかりにくい手順の文を選択し、⌥⌘Mを押して、どうあるべきかを書きます。まずページ全体に目を通しましょう。

3. 送信して、修正を確認する

   Sendをクリックします。エージェントがコメントごとに修正し、各修正は、古いテキストが赤、新しいテキストが緑で、そのコメントの横にファイル上で表示されます。AcceptまたはReopenで判断します。

4. 承認

   変更するところがなくなったら、Approveをクリックします。

コメントはファイルではなくDotMDが保管するので、MarkdownにマーカーもHTMLコメントも入りません。ページの名前を変えたり移動したりしても、コメントはついていきます。

すべてのバージョンを復元できる

DotMDは、開いたすべてのファイルの以前のバージョンを残します。履歴を開くと、各バージョンが整形されて表示され、1つ前からの変更が、追加は緑、削除は赤で示されます。

• Revertで、段落や表の行のような、変更された1つのブロックだけを元に戻し、残りはそのままにできます。
• Restoreで、以前のバージョン全体に戻します。現在のテキストは先にバージョンとして保存されるので、復元も元に戻せます。
• エージェントやgitなど、ほかのアプリが変更したファイルには、サイドバーにオレンジの点がつきます。開くと、DotMDは、前回読んでから変わった箇所へ直接移動します。

エージェントが作ったファイルは、最初に開くまで1つのバージョンだけを保ちます。そのため、変更は最初に読んだテキストからの差分として数えられます。

開いているファイルがディスク上で変わると、追加・削除された行数がバナーに表示され、Show Changesで、変更前のテキストと比べる履歴が開きます。

2つ目のエージェントに事実を確認させる

読みやすくても、間違っているページはあります。別のエージェントに確認を頼むと、その指摘は名前つきのコメントとしてDotMDに届き、書き手が見る前に、残すか削除するかを決められます。

「DotMDでdocs/install.mdをレビューして、動かないコマンドすべてにコメントを残して」

これは、エージェントがエージェントをレビューで説明している流れです。コメントを取捨選択するのはあなたなので、書き手に渡るのは、あなたが同意した指摘だけです。

読者に見える姿を確認する

DotMDは、Mermaid図、KaTeX数式、表、コールアウト、シンタックスハイライトつきのコードを描画するので、読者が読むとおりにページを読めます。渡すときは、PDFやHTMLに書き出す、リッチテキストとしてメール、メモ、Pages、Google Docsにコピーする、ブログやCMS向けにHTMLソースをコピーする、または印刷します。

テクニカルライターからの質問

その他の質問