claude 基本
文档创建与记忆更新遵循明确规则,旨在高效沉淀项目关键信息,避免重复劳动。本文档系统梳理了文档与记忆的管理原则、任务处理流程及沟通准则,帮助团队快速掌握全局上下文。

创建与更新原则: - 不创建用于工作汇报或任务总结的文档,此类无使用场景。 - 所有新增文档必须在 `.agentdocs/index.md` 中分类并记录。 - 当已有相关文档或记忆存在时,优先更新现有内容,而非新建。 - 更新文档或记忆时,需按原格式重新组织整理文件,避免单纯在末尾追加。 缺少文档的情况: - 在推进任务过程中,若发现任务依赖跨模块约束、设计约定、使用规范或历史决策(如样式基准、接口契约、复用组件规则等)且现有文档缺失,难以通过单次阅读局部代码快速掌握,应将整理并补充这些必要信息视为任务的一部分,及时写入对应文档。 - 文档补充后需更新 `.agentdocs/index.md`,继续执行剩余工作,后续按需迭代细化内容。 ### 文档 文档用于沉淀项目架构、领域边界与跨文件共性信息,帮助在处理复杂任务时快速了解全局上下文,避免重复遍历大量代码。 根据项目情况合理划分子目录与文档类型,例如: 1. 产品文档:记录用户想法或某个模块的功能设计。 2. 前端文档:描述前端技术架构与组件复用规则。 3. 后端文档:说明后端技术架构与接口规则。 特殊文档类型: - 任务文档:记录复杂任务的现状分析、方案设计、背后思考、任务阶段及TODO拆解等内容。存放于 `.agentdocs/workflow/` 目录下,文件名格式为 `YYMMDD-任务简述.md`,任务简述使用短横线连接的英文单词,如 `251007-fix-audio-player.md`。 ### 记忆 记忆用于沉淀项目中长期适用的重要共识、约束、原则或事实,确保处理不同任务时遵循一致执行准则。典型的记忆示例: 1. 新实现了可复用的自定义滚动条 React 组件 CustomScrollArea,在前端相关文档中记忆:“开发时滚动容器都应优先使用 CustomScrollArea”。 2. 后端实现完成了统一的 LLM 请求管理器 LLMManager,在后端相关文档中记忆:“所有大模型请求统一走LLMManager,不允许自行实现”。 ## 任务处理指南 1. 启动新任务时,先读取索引文档 `.agentdocs/index.md`,了解现有背景文档与记忆状态。 2. 执行任务时参考索引,自主决定是否查阅相关文档或记忆,需要信息时主动读取对应文档。 3. 当需求不明确时,在继续之前向用户提出问题来澄清需求。 4. 当简单问题超过两次修改仍未解决,应视为复杂任务处理,进行深入分析和规划。 5. 对于用户提出的设想和意见,结合项目情况进行全面客观分析,而非一味遵循。 6. 对于复杂任务,在分析和规划阶段先从宏观抽象层面厘清问题,再回到具体执行步骤。 7. 对于复杂任务(例如涉及多个模块或跨域变更),必须先制定分阶段实施计划并创建任务文档,然后按阶段调用 Planning Tool 推进执行。 ### 任务回顾 在任务完成后,呈现最终消息前必须主动完成任务回顾,并根据任务执行情况判断是否需要形成或更新文档、记忆:若产出新的可复用模式、跨文件约束或关键决策,则写入对应文档;若仅影响局部实现且无长期价值,则无需写回。 对于使用任务文档的复杂任务: 1. 每完成一个阶段,必须更新文档中的TODO状态。 2. 所有阶段完成后,提醒用户进行人工验收和确认,用户确认无其他改动后,将对应任务文档移动至 `.agentdocs/workflow/done/`,并从索引文档的“当前任务文档”部分移除。 ## 沟通原则 - 与用户的所有回复与沟通,文档与代码注释均使用中文,必要时可保留英文专业名词,并在首次出现时附简要中文注释。
综上,通过严格执行文档创建、更新及任务处理流程,团队能够高效协作并沉淀知识。请牢记上述原则,确保每一次任务都能有序推进并形成有价值的资产。