文件由代理來寫,由你確保正確。
AI 代理寫文件時,需要有人檢查。閱讀排版後的每一頁,在錯誤的地方留言,查看每項變更,並還原任何版本。
需要 macOS 14 或以上版本。閱讀免費;DotMD Pro 提供 3 天免費試用。
快速解答
在 DotMD 開啟文件資料夾,閱讀排版後的每一頁。在代理出錯的地方留言;它會逐則修正,你在檔案中接受變更。每個版本都會保留,所以你可以比較草稿、還原單一區塊,或還原整頁。版本記錄、資料夾搜尋和匯出屬於 DotMD Pro(可免費試用 3 天)。
排版後的文件資料夾
把文件資料夾拖到 DotMD,它就成為你的工作區。頁面在分頁中開啟,側邊欄依標題而不是檔名列出。標題來自頁面 front matter 的 title: 欄位,沒有的話則取第一個標題。屬性會以卡片形式顯示在頁面上方。
⇧⌘F 會在工作區的所有資料夾中搜尋檔名與每一行文字,所以找到提到某項設定的頁面只要一秒。
審閱代理的草稿
-
以檔案形式索取頁面
「把安裝指南寫到 docs/install.md,並在 DotMD 送給我審閱。」
-
對每個問題留言
選取有錯誤指令或步驟不清楚的那一句,按下 ⌥⌘M,寫下它該是什麼樣子。先把整頁看完。
-
送出,再檢查修正
按 Send。代理逐則修正,每項修正都顯示在檔案中,舊文字為紅色、新文字為綠色,就在它的留言旁邊。Accept 或 Reopen。
-
核准
沒有需要修改的地方時,按 Approve。
留言由 DotMD 保存,不在檔案裡,所以你的 Markdown 沒有任何標記或 HTML 註解。你重新命名或移動頁面時,留言會跟著它。
每個版本都能還原
DotMD 會保留你開啟過的每個檔案的先前版本。開啟紀錄後,每個版本都以排版後的樣子顯示,並標出相較前一版的變更:新增的文字為綠色,刪除的為紅色。
- Revert 可還原單一變更的區塊,例如一個段落或一個表格列,其餘保持不變。
- Restore 可還原整個先前的版本。目前的文字會先儲存為一個版本,所以還原本身也能復原。
- 被其他 App(例如代理或 git)修改過的檔案,會在側邊欄出現橘色圓點。開啟它,DotMD 會直接帶你看自上次閱讀以來改了什麼。
代理建立的檔案在你第一次開啟前只保留一個版本,所以變更是從你最先讀到的文字開始計算。
當開啟中的檔案在磁碟上變動時,橫幅會顯示新增與刪除了幾行,而 Show Changes 會開啟與先前文字比較的紀錄。
讓第二個代理查核事實
一頁文件可能讀起來很順,卻仍然是錯的。請另一個代理來檢查,它的意見會以附有它名稱的留言送到 DotMD,在撰寫者看到之前,由你決定保留或刪除:
「在 DotMD 審閱 docs/install.md,並在每個無法執行的指令上留言。」
這就是一個代理審閱另一個中描述的流程。留言由你把關,所以撰寫者只會收到你同意的意見。
檢查讀者會看到什麼
DotMD 會繪製 Mermaid 圖表、KaTeX 公式、表格、標註區塊,以及有語法上色的程式碼,所以你讀到的就是讀者會讀到的樣子。要交給別人時,可以匯出成 PDF 或 HTML、以格式化文字複製到郵件、備忘錄、Pages 或 Google Docs、複製它的 HTML 原始碼用於部落格或 CMS,或列印出來。
技術文件撰寫者常問的問題
DotMD 支援 front matter 嗎?
支援。屬性會以卡片顯示,檔案的 title: 可以在側邊欄中作為它的名稱。
我可以搜尋整個文件資料夾嗎?
可以,使用 DotMD Pro:⇧⌘F 會在工作區的所有資料夾中找出檔名,以及每一行含有該文字的內容。
我可以匯出頁面嗎?
可以,使用 DotMD Pro:PDF、HTML、Copy as Rich Text、Copy HTML Source,或列印。
檔案移動後,留言會怎樣?
你在新位置第一次開啟檔案時,它們就會回來。