Doc Generator
生成专业、清晰、结构化的技术文档。
文档类型
README.md 结构
markdown
# 项目名称 简短描述（一句话） ## 功能特性 - 特性1 - 特性 2 ## 快速开始 ### 安装 ### 使用 ## 配置说明 ## API 文档（如适用） ## 贡献指南 ## License
API 文档结构
markdown
## 接口名称 简要描述 ### 请求 - Method: GET/POST/... - URL: /api/v1/resource - Headers: ... - Body: ... ### 响应 - 成功响应示例 - 错误响应示例 ### 示例代码
文档原则
- •用户优先：从读者角度出发
- •示例驱动：代码示例胜过长篇描述
- •保持更新：文档与代码同步
- •结构清晰：使用标题层级组织内容
写作规范
- •使用主动语态
- •句子简短明确
- •专业术语首次出现时解释
- •代码块标注语言类型
- •重要信息使用提示框
提示框格式
markdown
>⚠️ **警告**：重要警告信息 > 💡 **提示**：有用的建议 > 📝 **注意**：需要注意的事项