概述
Technical Documentation Engine 是一套面向软件工程团队的完整技术文档解决方案，覆盖文档规划、编写、评审、自动化到维护的全生命周期管理。
核心用法
该技能提供8个系统化阶段的工作流：
1. 文档审计 — 使用0-3分评分卡量化现有文档缺口，输出A-F等级与优先修复建议
2. 文档类型与模板 — 提供7类标准化模板：README、入门指南、API参考、架构文档、运维手册、贡献指南、变更日志
3. 编写标准 — "4C测试"（正确、完整、清晰、简洁）与详细的风格规范，包含受众分级策略（初学者/中级/专家/运维人员）
4. 质量评分 — 100分制8维度评估体系（准确性、完整性、清晰度、结构、示例、可维护性、可搜索性、可访问性）
5. 文档架构 — 开发者门户的信息架构设计，遵循"3次点击内可达"与"搜索优先"原则
6. 自动化流水线 — Docs-as-Code集成：提交时检查链接/拼写、PR时预览与AI审阅、周期性外链审计与新鲜度追踪
7. 特殊文档类型 — 迁移指南、错误目录、架构决策记录(ADR)的专项格式
8. 维护系统 — 新鲜度追踪、文档债务管理、弃用流程标准化
显著优点
- 即插即用的工业级模板：所有模板均经过实战验证，包含具体占位符与示例，可直接落地
- 量化驱动的质量管控：100分评分表与审计清单将主观文档评审转化为可执行标准
- 受众意识明确：强制区分读者层级，避免"一个文档服务所有人"的常见陷阱
- 自动化优先：从代码生成API文档、CLI参考，到CI集成测试代码示例，减少人工维护负担
- 运维视角完整：专门覆盖runbook、错误目录、监控告警等生产环境必备文档
潜在局限
- 模板依赖风险：团队若机械套用而不理解设计意图，可能产生"形似神不似"的文档
- 自动化成本：完整的Docs-as-Code流水线需要 upfront 工程投入，小型团队可能过度设计
- 版本碎片化：多语言/多版本项目的文档矩阵管理复杂度未完全解决
- 中文本地空白：模板与示例均为英文，中文技术文档的特殊场景（如混合排版）需自行适配
适合人群
- 技术写作者/文档工程师：寻求标准化工作流与质量度量工具
- 开源维护者：需要专业README与贡献指南以提升项目可信度
- 平台/基础设施团队：需建立运维手册体系与错误目录
- 技术管理者：希望将文档质量纳入工程流程与绩效考核
常规风险
- 文档债务累积：若无强制review周期，自动化的新鲜度追踪可能沦为数字游戏
- 安全信息泄露：架构文档、runbook中可能意外暴露内部系统细节，需脱敏流程
- 示例代码漏洞：直接可运行的代码片段若包含真实密钥或危险操作，可能造成安全事故
- 链接腐烂：外部依赖文档URL变更会导致大量失效引用，需定期审计机制