用途:在项目发生重大变更(新增或删除功能、架构或设计模式调整、依赖与技术栈更新、API 端点或数据库结构变化、目录重构、开发流程变化)后,系统性更新项目文档,保持各文件一致准确。也用于会话结束时用户说“update project documentation”“update docs”或“close for the day”的场景。
主要能力:按“具体到一般”的顺序更新文档,先技术规格(docs/API.md、docs/DATABASE.md),再架构(ARCHITECTURE.md、TECH_STACK.md),再 AI 指令(CLAUDE.md),再用户指南(README.md),最后概览(PROJECT_BRIEF.md);每次会话必须更新 docs/plans/NEXT_FEATURES.md,并同步 docs/plans/INDEX.md、MEMORY.md,可选生成当日总结。提供变更到文件的映射规则、逐文件检查清单、一致性校验(术语、版本号、路径、组件名、功能描述)与常见错误提示。
使用方式:先理解变更类型、影响与是否破坏兼容,再映射受影响文件,并行读取当前内容,逐文件更新主段落、相关段落与示例,必要时添加迁移说明,最后做一致性检查并更新 NEXT_FEATURES.md。文档规范要求所有 .md 文件不超过 500 行,采用高层目录加深度专题的两级结构;CLAUDE.md 控制在 10k 字符以内,作为导航枢纽链接到 docs/ 子目录;所有文档 markdown 放在 docs/ 加语义子目录下,根目录 README.md 只指向 docs/。
适用场景:功能增删、架构或技术栈变更、API 与数据库变更、目录重构、开发流程调整、会话收尾。
限制:不适用于拼写修正、代码注释、尚未合并的进行中功能;文档需反映 Windows 开发、Ubuntu 预发、Debian 生产三环境(均为 MySQL 8.x)的部署上下文。具体命令与模板细节资料未完整提供。