文件產生器
語言: English | 繁體中文
從專案原始檔案產生使用文件(速查表、參考手冊、使用指南)。
工作流程
- 讀取設定 - 載入
.usage-docs.yaml(或指定的設定檔) - 掃描來源 - 讀取原始碼檔案、命令和技能定義
- 提取內容 - 從原始碼解析描述、選項、範例
- 產生文件 - 以設定的格式產生輸出
- 寫入輸出 - 將產生的檔案儲存到設定的輸出目錄
設定檔格式
# .usage-docs.yaml
output_dir: docs/generated/
formats:
- cheatsheet
- reference
sources:
- path: skills/commands/
type: commands
- path: cli/src/commands/
type: cli
language: [en, zh-TW]
輸出類型
| 類型 | 說明 |
|---|---|
| cheatsheet | 速查表,包含命令和快捷鍵 |
| reference | 完整功能參考手冊,包含所有選項 |
| usage-guide | 新手入門使用指南 |
使用方式
/docgen- 使用預設的.usage-docs.yaml產生文件/docgen .usage-docs.yaml- 從指定的設定檔產生文件/docgen --format cheatsheet- 僅產生速查表
下一步引導
/docgen 完成後,AI 助手應建議:
文件已產生。建議下一步:
- 審查產生的文件內容是否完整
- 執行
/commit提交文件變更- 執行
/code-review審查文件品質
參考
- 詳細指南:guide.md