ShaoHua
9223ceca50
- 规则重组：全局/ 下 8 个规则合并为 6 个（01+02→01，05+06→04），序号顺延 - 新增项目规则 05-多入口功能同步规范（UI/语音入口覆盖检查） - 新增 MCP 服务基础设施：Mcp/ 目录（DI 注册、端点扩展、动态工具描述符）、单元测试 - v1.3.0 工单文档：03 系列（会议任务拆分）、04（富文本描述与附件管理） - MCP 接口与前端集成指南：docs/manual/08、09
2.6 KiB
2.6 KiB
alwaysApply, description
| alwaysApply | description |
|---|---|
| true | 强制文档同步规范：每次变更代码（如新增功能、修改接口、调整架构等）必须同步更新 README.md 和 docs 目录下的相关文档。 |
文档同步规范（必须遵守）
适用范围：本规则属于 全局规则（跨项目通用）。
通用原则
- 代码即文档，文档随代码：文档不是静态的，它必须真实反映当前代码的状态。
- 及时性：在提交代码变更的同时（或紧随其后），必须完成相关文档的更新。
- 准确性：确保文档中的示例代码、接口说明、安装步骤与实际代码完全一致。
- 协作友好（局部修改）：当并行处理多个研发工单/需求时，更新文档应尽量只修改与本工单直接相关的段落/小节，避免对不相关内容做无意义的重排、改写或格式化；如必须调整非关联内容，应拆分为独立的变更说明清楚原因与影响范围。
术语澄清：本规范中"研发工单"指编码工作项；项目业务里的"任务/Todo 待办项"是用户域实体，二者不要混淆。详见 04-研发工单全流程规范.md。
更新范围
- README.md：
- 如果变更涉及核心功能点（Features）、安装步骤（Installation）、快速开始（Quick Start）或 API 端点（API Endpoints），必须同步更新。
- 变更涉及技术栈调整或项目结构变化时需更新。
- docs/ 目录文档：
检查清单
- 是否有新增的 API 端点？（更新 README 和技术设计文档）
- 是否修改了现有的业务逻辑或数据结构？（更新技术设计文档）
- 是否有新增的功能模块？（更新产品需求文档和技术栈说明）
- 是否调整了开发环境或依赖？（更新 README）
- 是否在 版本记录.md 中记录了本次变更？
- 文档变更是否保持"局部修改"，只影响与本工单相关的段落/小节？（避免无关重排/改写）