Hua.Todo/.trae/rules/documentation_sync.md

alwaysApply, description

alwaysApply	description
true	强制文档同步规范：每次变更代码（如新增功能、修改接口、调整架构等）必须同步更新 README.md 和 docs 目录下的相关文档。

文档同步规范（必须遵守）

通用原则

• 代码即文档，文档随代码：文档不是静态的，它必须真实反映当前代码的状态。
• 及时性：在提交代码变更的同时（或紧随其后），必须完成相关文档的更新。
• 准确性：确保文档中的示例代码、接口说明、安装步骤与实际代码完全一致。
• 协作友好（局部修改）：当并行处理多个任务/需求时，更新文档应尽量只修改与本任务直接相关的段落/小节，避免对不相关内容做无意义的重排、改写或格式化；如必须调整非关联内容，应拆分为独立的变更说明清楚原因与影响范围。

更新范围

• README.md：
  • 如果变更涉及核心功能点（Features）、安装步骤（Installation）、快速开始（Quick Start）或 API 端点（API Endpoints），必须同步更新。
  • 变更涉及技术栈调整或项目结构变化时需更新。
• docs/ 目录文档：
  • 接口变更：若修改了 API，需同步更新 技术设计文档 中的接口部分。
  • 功能新增/调整：需在 产品需求文档 和 技术栈与模块 中体现。
  • 架构/模式变更：需更新 技术设计文档。
  • 代码规范：若引入了新的编码模式或工具，需更新 代码规范文档。
  • 版本记录：所有非琐碎的变更必须在 版本记录.md 中添加记录。

检查清单

1. 是否有新增的 API 端点？（更新 README 和技术设计文档）
2. 是否修改了现有的业务逻辑或数据结构？（更新技术设计文档）
3. 是否有新增的功能模块？（更新产品需求文档和技术栈说明）
4. 是否调整了开发环境或依赖？（更新 README）
5. 是否在 版本记录.md 中记录了本次变更？
6. 文档变更是否保持“局部修改”，只影响与本任务相关的段落/小节？（避免无关重排/改写）