用途:为项目文档提供编写、审计与维护方法论,目标是让开发者快速准确上手,避免过时文档带来错误信心。范围限于人工编写的文档(docs/、README.md);生成产物与 Claude 配置文件不在此技能内。
主要能力:
- 文档类型划分:README、架构、API 参考、领域实体、认证、数据库、测试、功能路线图、审计报告、执行摘要等,各自标明受众、目的与更新触发条件。
- 审计现有文档:先盘点文件与行数、修改日期,再与代码交叉比对(路由、schema、迁移、已交付功能、认证实现、Justfile 命令),并按严重程度分类:严重(文档与事实相反)、高(重要内容缺失)、中(细节过时)、低(格式措辞)。
- 常见漂移模式与修复:认证状态过时、端点缺失、审计结论未更新、已交付功能仍标 planned、字段名错误、分页未记录、错误响应缺失等;以优先级表格汇报问题、文件与影响。
- 编写新文档:标题格式统一,一段式概述,结构化数据用表格,示例用真实数据,流程用 ASCII 图,交叉引用而非重复内容。README 应回答是什么、技术栈、如何安装、如何运行、去哪了解更多,并控制在 120 行以内。API 参考需记录方法路径、认证、查询参数、请求体、响应体、错误码与 CQRS 读写池使用。
- 导航与可发现性:一文件一主题,README 用表格链接全部文档,文档间交叉引用;文件内用水平线分隔大节、用可作目录的标题、高频内容靠前;链接代码用文件路径而非行号,绝不跨文档复制内容。
- 防止漂移:文档是交付物,功能未更新文档不算交付;新增端点、行为变更、校验规则、迁移、功能上线、认证流程、安装步骤、新命令、修复审计问题都须在同一 PR 更新文档。可借助路径规则自动提示、Swagger UI 等生成文档减少签名漂移;纯重构、加测试、格式变更、依赖更新可跳过。
- 维护节奏:每个 PR 更新行为变更并检查旧描述;每季度或重大里程碑做全量审计,检查 planned 功能是否已上线、审计结论是否已解决、README 安装步骤是否仍可用。
使用方式:按上述流程对项目 docs/ 与 README.md 进行盘点、交叉比对、分类与修复;具体命令与自动化脚本资料中未提供。
适用场景:需要长期维护文档、多开发者协作、有 API 与数据库变更、需要季度审计的项目。
限制:仅覆盖人工文档;生成产物与 Claude 配置文件不在范围内;文档未提供具体命令、工具集成细节或自动化实现。