文档命令 (/document)
智能文档生成和维护命令，支持API文档、用户指南、技术规范等多种文档类型。
核心功能
- 自动生成: 基于代码自动生成API文档
- 多格式支持: Markdown、HTML、PDF等格式
- 模板系统: 内置多种文档模板
- 国际化: 多语言文档支持
- 版本管理: 文档版本控制和更新
使用语法
bash
/document [类型] [目标] [选项]文档类型
api- API接口文档readme- README文档guide- 用户指南spec- 技术规范changelog- 变更日志
主要选项
--format markdown|html|pdf- 输出格式--language zh|en- 文档语言--template modern|classic|minimal- 文档模板--auto-update- 自动更新文档
文档类型详解
API文档生成
bash
# 基于OpenAPI规范生成
/document api --source=openapi.yaml --format=html
# 基于代码注释生成
/document api --analyze-code --routes=/api/* --interactiveREADME文档
bash
# 智能分析项目生成README
/document readme --auto-analyze --template=modern
# 基于模板创建README
/document readme --template=startup --interactive用户指南
bash
# 创建安装和使用指南
/document guide --type=installation,usage --screenshots
# 创建API使用指南
/document guide --api-examples --code-samples模板系统
内置模板
| 模板 | 适用场景 | 特色 |
|---|---|---|
| Modern | 现代项目 | 响应式设计、深色模式 |
| Classic | 传统项目 | 简洁布局、标准格式 |
| Minimal | 轻量项目 | 极简设计、快速加载 |
| Enterprise | 企业项目 | 品牌一致、详细规范 |
自定义模板
bash
# 创建自定义模板
/document --create-template --name=my-template
# 使用自定义模板
/document api --template=my-template --branding国际化支持
多语言文档
bash
# 生成中英文文档
/document api --languages=zh,en --sync-content
# 翻译现有文档
/document --translate --source=zh --target=en --ai-translate本地化特性
- 日期格式本地化
- 货币和数字格式
- 文化适应性调整
- 右到左语言支持
文档维护
自动更新
bash
# 监听代码变更自动更新文档
/document --watch --auto-sync
# 定期检查文档过期
/document --health-check --outdated-warning版本管理
bash
# 创建文档版本
/document --version=2.1.0 --changelog
# 比较文档版本
/document --compare --version1=2.0.0 --version2=2.1.0智能特性
内容分析
bash
# 分析文档完整性
/document --analyze --completeness-score
# 检查文档质量
/document --quality-check --readability-score交互式生成
bash
# 向导模式创建文档
/document --wizard --step-by-step
# 问答式内容生成
/document --interactive --smart-questions文档命令 - 让代码会说话的智能文档生成