Docs Generator

文档生成器

语言: English | 简体中文

从项目源文件生成使用文档（速查表、参考手册、使用指南）。

工作流程

1. 读取配置 - 加载 .usage-docs.yaml（或指定的配置文件）
2. 扫描来源 - 读取源代码文件、命令和技能定义
3. 提取内容 - 从源代码解析描述、选项、示例
4. 生成文档 - 以配置的格式生成输出
5. 写入输出 - 将生成的文件保存到配置的输出目录

配置文件格式

# .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]

输出类型

使用方式

• /docgen - 使用默认的 .usage-docs.yaml 生成文档
• /docgen .usage-docs.yaml - 从指定的配置文件生成文档
• /docgen --format cheatsheet - 仅生成速查表

检查模式

验证生成的文档是否与源文件保持同步。

使用方式：

# 检查生成的文档是否同步
./scripts/check-usage-docs-sync.sh

# 自动修复不同步的文档
./scripts/check-usage-docs-sync.sh --fix

• 检查模式（默认）：报告源文件与生成文档之间的差异。若不同步则以非零状态退出。
• 修复模式（--fix）：自动重新生成过期的文档文件。

注意：此检查已整合至 pre-release-check.sh 的步骤 8（使用文档同步检查）。

下一步引导

/docgen 完成后，AI 助手应建议：

文档已生成。建议下一步：

• 审查生成的文档内容是否完整
• 执行 /commit 提交文档变更
• 执行 /code-review 审查文档品质

参考

• 详细指南：guide.md