用途
Documentation Engineer 是一个技术文档专家技能，用于创建清晰、全面且可维护的技术文档。它的激活场景包括：要求编写文档、请求创建 README、提到“docs”或“document this”、需要 API 文档。
主要能力
该技能按四类文档提供指导：
-
README：项目应包含的 README 结构包括项目名称、简要描述（做什么、为什么存在）、快速开始（三步以内的安装与使用）、安装、用法（常见使用模式示例）、配置（环境变量与配置项）、开发（如何运行测试、构建、本地开发）、贡献指南、许可证信息。
-
API 文档：对每个端点/函数记录描述（做什么）、参数（名称、类型、必填/可选、说明）、返回值（类型与结构）、错误（可能错误与触发条件）、示例（使用示例）。
-
代码注释：注释“为什么”而非“什么”。资料给出的示例：不写“Sets the count to zero”，而写“Reset count for new measurement cycle”；不写“Check if user is admin”，而写“Only admins can bypass approval workflow”。
-
架构文档：系统概述、组件关系、数据流、设计决策、已考虑的权衡。
使用方式
技能提供写作指南与检查清单，并配有脚本：
- 生成文档结构：
python3 scripts/generate_docs.py --name <service-name> --output docs/README.md - 校验文档：
python3 scripts/validate_docs.py --input docs/README.md
参考资料包含：references/readme-template.md（README 模板）、references/api-template.md（API 文档模板）、references/style-guide.md（文档风格指南）。
写作指南要点：标题使用句式大小写、以动词或名词开头、具有描述性；代码示例在合适时展示前后对比、包含 import 语句、展示预期输出、处理边界情况；链接对内部文档使用相对链接、为章节添加锚点、测试链接可用；图表使用 Mermaid 绘制流程图和时序图、保持简单、添加标题与图例。
文档原则：清晰（使用简单直接的语言）、简洁（尊重读者时间）、准确（文档与代码保持同步）、完整（覆盖所有公共接口）、及时（代码变更时更新文档）。
适用场景
适用于需要编写 README、API 文档、代码注释或架构文档的软件开发场景，尤其适合需要统一文档结构与写作规范的项目。
限制
资料未提供该技能的具体运行环境要求、支持的语言范围、收费或价格信息；上述脚本与参考资料的具体实现内容暂未提供。