前言¶
寫代碼時，文檔往往是最先被砍掉的一環。時間緊，先跑通功能；代碼「自文檔化」，命名清楚就夠了；這個需求下個迭代再補文檔。等到要交付、要交接、要排查線上問題時，README 缺一塊、API 說明對不上實現、技術指南只剩幾行，返工成本遠高於當時補文檔的成本。
文檔助手（Skill 座標 @user_3c47cf70/doc-writer）就是針對這個痛點設計的：凡是涉及創建文檔、README 文件、API 文檔、代碼註釋或技術指南的場景，它都會介入，防止遺漏文檔、確保覆蓋完整，並且要求在編寫代碼的同時編寫文檔，不因時間壓力、「自文檔化」聲明或範圍限制而豁免。
這是什麼¶
文檔助手是一個基於通用 SKILL.md 格式的 Agent Skill，用於在開發過程中強制、完整地產出配套文檔。
- 名稱：文檔助手
- 座標：@user_3c47cf70/doc-writer
- 官方地址：https://api.skillhub.cn/user_3c47cf70/doc-writer
- SkillHub 頁面：https://www.skillhub.cn/skills/user_3c47cf70/doc-writer
- 版本：1.0.0
- 來源：community
- 分類：dev-programming
- 發佈者：user_3c47cf70
- 標籤：requires_api_key=false
- 評分：100000（SkillHub），下載 1090 次，安裝 0 次
它解決的問題很單一：文檔不是開發流程的可選項，而是與代碼同批交付的一部分。
核心功能¶
根據官方簡介，文檔助手的能力集中在三件事上：
- 防止遺漏文檔。觸發場景覆蓋文檔、README 文件、API 文檔、代碼註釋和技術指南，要求在這些場景下必須產出對應文檔，而不是默認跳過。
- 確保全面覆蓋。文檔需要覆蓋的對象要完整，不能只寫一部分、留幾個「TODO」充當文檔。
- 強制代碼與文檔同批編寫。寫代碼的同時寫文檔，明確不因時間壓力、「自文檔化」這類說法或範圍限制而延後，即不承認「先寫代碼、後補文檔」的常見做法。
安裝與啓用¶
目前公開資料（SkillHub 頁面與官方接口信息）只給出了座標 @user_3c47cf70/doc-writer 和地址 https://api.skillhub.cn/user_3c47cf70/doc-writer，沒有提供可直接複製的安裝命令。
該 Skill 基於通用 SKILL.md 格式，啓用方式取決於你使用的 Agent 客戶端：
- 使用 SkillHub 相關客戶端時，按座標
@user_3c47cf70/doc-writer添加該 Skill。 - 手動使用時，將該 Skill 的 SKILL.md 放入對應客戶端的 Skills 目錄，或通過
/skills命令安裝。 - 官方頁面標註 requires_api_key=false，使用時不需要額外配置 API Key。
本文不寫未經官方資料覈實的具體命令，避免給出無法驗證的安裝步驟。
典型用法¶
文檔助手的使用方式是觸發式的：當任務涉及創建文檔、README 文件、API 文檔、代碼註釋或技術指南時，由 Agent 加載該 Skill，按其規則執行。
可以復現的用法是：在提出開發需求時，同時說明需要交付的文檔類型，例如：
- 新增一個服務模塊，要求同時產出 README、接口文檔和關鍵代碼註釋。
- 修改現有 API，要求同步更新 API 文檔中的參數與返回值說明。
- 寫技術方案或技術指南，要求覆蓋背景、設計、使用方式和邊界條件。
在這些場景下，文檔助手會要求 Agent 把文檔與代碼作爲同一交付物處理，而不是等到代碼寫完再回頭補。
適用場景與注意¶
適合誰：
- 在迭代節奏快、文檔容易被壓縮的團隊裏負責代碼交付的開發者。
- 需要同時維護 README、API 文檔、代碼註釋和技術指南，且希望 Agent 主動提醒不要漏項的人。
- 想把「寫文檔」明確寫進開發流程，而不是靠個人習慣維持的團隊。
使用上的限制和注意點：
- 評分與下載數據來自 SkillHub 頁面，安裝量爲 0，說明實際使用反饋樣本很少，不要據此判斷其實際效果。
- 它屬於 community 來源，發佈者爲 user_3c47cf70，使用前建議先查看其規則內容。
- 強制寫文檔會帶來額外的篇幅與時間成本，對一次性原型、實驗性代碼這類場景可能並不划算，可以按需跳過。
- 「自文檔化」被該 Skill 明確列爲不構成豁免的理由，如果你的代碼確實依賴清晰命名和類型系統自解釋，需要自己權衡是否啓用。
小結¶
文檔助手的價值在於把文檔從「有空再補」變成開發流程中的強制步驟：覆蓋文檔、README、API 文檔、代碼註釋和技術指南，要求與代碼同批編寫，不接受時間壓力或「自文檔化」作爲跳過理由。
官方地址：https://api.skillhub.cn/user_3c47cf70/doc-writer
