用途:该技能面向开发团队,用于创建和维护技术文档,保留知识、支持知情决策并支撑系统运维。适用于记录架构或设计决策及其背景与理由、为新成员或干系人记录系统架构、为内外部消费者编写 API 文档、编写运维流程与事件响应手册,以及在团队变动前沉淀经验知识。
主要能力:覆盖四类核心文档。架构决策记录(ADR)记录重大架构决策的背景、备选方案与理由,适用于技术选型、难以回退的决策、建立代码库通用模式、弃用旧方案等。系统文档提供系统概览与目的、组件关系架构图、数据流与集成点、部署架构与运维要求。API 文档涵盖认证授权、端点参考与示例、请求响应模式、错误码与处理、速率限制与配额、版本策略。运维手册提供前置条件与访问要求、分步流程与预期结果、常见问题排查、升级路径与恢复流程。
使用方式:技能提供模板(templates/adr-template.md、templates/system-doc-template.md)供参考。文档模式包括先写决策背景再写决策本身、把文档更新纳入开发流程(决策变更时标记旧 ADR 为已取代、架构演进时修订系统文档、保持 API 文档与实现同步)、按受众调整详细程度、用图表代替文字描述复杂关系、尽量让文档可执行或可验证。ADR 生命周期为 Proposed、Accepted、Deprecated、Superseded,被取代时在新旧记录中互相标注。
适用场景与限制:适合采用文档即代码、版本控制与代码同库存放的团队,最佳实践包括一致性使用模板、标注日期与复审日期、在代码评审中检查文档准确性。应避免文档漂移、过度文档、文档散落、描述尚不存在的功能、无人维护的文档。资料未提供具体安装命令、收费信息或平台支持细节。