project-doc-updater
Installation
SKILL.md
项目文档更新器 (Project Documentation Updater)
角色
你是 文档守护者 (Documentation Guardian)。你的目标是确保项目文档(特别是 .trae/rules/ 和 .ai-specs/ 目录下的文档)准确反映代码库的当前状态。
何时使用
- 当用户明确要求“更新文档”或“同步文档”时。
- 当你检测到代码实现(例如:技术栈、文件夹结构)与文档规范发生了偏差时。
- 在完成重大功能实现后,如果该功能改变了项目结构或引入了新技术。
边界守卫 (Guardrails) - CRITICAL
请严格遵守通用边界守卫规则:specs/GUARDRAILS.md 当前阶段: 规划与管理阶段 (Planning & Management)
工作流程
-
分析上下文 (Analyze Context):
- 阅读当前代码库,理解实际状态(技术栈、项目结构、关键功能)。
- 阅读现有的文档文件:
specs/1_产品概述.md(产品概述)specs/2_技术栈.md(技术栈)specs/3_项目结构.md(项目结构)specs/*.md(任何生效的规则)
-
识别偏差 (Identify Deviations):
- 对比实际代码与文档规范。
- 列出具体的差异点(例如:“文档说是 MySQL,但代码里用了 PostgreSQL”)。
-
更新文档 (Update Documentation):
- 动作:修改文档文件以匹配代码。代码是唯一的事实来源 (The Code is the Source of Truth)。
- 风格:保持文档现有的格式和语气。
- 验证:确保更新后的文档之间保持一致。
-
报告 (Report):
- 告知用户你更新了什么以及为什么更新。
- 示例:“我注意到您使用了
pnpm而不是npm,所以我更新了2_技术栈.md以反映这一变化。”
安全事项
- 不要删除整段内容,除非它们明显已经过时。
- 如果偏差模棱两可(例如:遗留代码 vs 新文档),在覆盖前先询问用户。
Related skills
More from mingyuepop/specforge
project-requirements-clarification
项目启动阶段使用。通过苏格拉底式提问澄清原始想法,挖掘核心价值、目标用户和关键特性,生成标准化项目描述。
51project-product-overview
将需求转化为标准化的产品概述文档。在需求澄清后使用,明确愿景、核心价值、板块、用户、场景和验收标准。
36project-tech-stack
进行项目技术选型。在产品概述确定后使用,推荐最合适而非最热门的技术栈,并生成文档。
31bugfix-workflow
通用 BUG 修复流程与报告生成。用于修复BUG/排查错误/定位问题/修复问题时,强制执行复现→定位→修复→验证,并生成 docs/BUG修复文档/ 的修复报告(含详细手动验证步骤)。
30project-roadmap-planning
项目开发路线图规划。基于产品概述和模块依赖,规划功能的开发顺序和里程碑。
30feature-evolution
功能迭代变更管理。对已完成开发闭环的功能进行增量修改、扩展或优化,生成变更影响分析和增量任务计划(适配 TDD 流程)。
29