用途
tl-docs-audit 用于审计现有文档，检查其中的缺失、过时和同步问题，并生成可操作的同步报告。它适合在以下场景使用：
- 加入一个已有文档的项目时
- 重大重构之后
- 季度文档审查
- 需要审查文档覆盖范围、查找过时文档、将文档与代码同步时
如果需要从零创建新文档，应使用 tl-docs-create。
主要能力
该技能会产出以下结果：
- 带有分类发现的同步报告
- 代码到文档的映射表
- 按优先级排列的建议编辑列表
- 可选的已修复文档
审计过程分为五个阶段：
- 功能清单：在比较之前，扫描代码库中可文档化的元素，包括公共 API、配置、环境变量、CLI 命令、路由/端点、数据库模式、组件等。
- 文档优先检查：遍历现有文档，对照功能清单检查覆盖情况，按类别标记发现的问题。
- 代码优先检查：从代码出发，验证每个元素是否有充分的文档，并创建代码到文档的映射表。
- 同步报告：生成结构化的发现报告。
- 可选修复：如果用户选择“报告 + 修复”，则实施建议的编辑。
使用方式
使用前，技能会通过结构化问题收集范围信息，包括：
- 轻量扫描——清点现有文档
- 范围——完整审计 / 仅变更文件 / 特定区域
- 输出——仅报告 / 报告 + 修复
- 修复确认——逐项批准（如果选择修复）
发现类别包括：
- 缺失：功能存在但未文档化
- 过时：文档描述旧行为
- 结构：文档存在但组织不佳
- 孤立：文档未从任何地方链接
- 不完整：文档存在但缺乏深度
同步报告包含摘要、文档优先发现、代码优先缺口和建议编辑。
如果选择修复，流程包括：逐项展示建议编辑以供确认、使用 tl-docs-create 的写作标准保持一致性、为修改的文件添加“最后更新”日期、运行验证清单。
适用场景
- 新功能合并后：仅检查变更文件，查找文档缺口
- 重大发布：完整代码库，生成完整同步报告
- 季度审查：完整代码库，进行过时审计
- 开发者入职：按职责区域，验证文档是否最新
过时指标包括：90 天以上未更新、引用已弃用 API、链接到已删除文件、提及过时的依赖版本。
当内容出现在多个位置时，应识别唯一可信来源，原则是：编辑源而不是副本、使用链接而非重复、同步而非分歧。
限制
该技能的具体配置模式、完整同步报告模板等细节在 references/configuration.md 和 references/sync-report.md 中提供。自动化工具方面提及 Vale、linkinator、alex、markdownlint 以及 CI 集成示例。相关技能包括 tl-docs-create 和 tl-docs-viewer-create。关于收费、价格、平台支持等具体信息暂未提供。