文案写作 通用 中文 English 架构文档 记录此仓库中 [the feature or system change] 的架构。以验证为依据,而非猜测:每个组… 生成后的提示词 记录此仓库中 `[the feature or system change]` 的架构。以验证为依据,而非猜测:你命名的每个组件都存在于代码中,你描述的每条流程都已在其中追踪过。 ## 步骤 1. **理解变更** - 阅读 PR、它涉及的代码以及任何现有文档。在写任何内容之前,确定改了什么以及为什么改。 2. **识别组件** - 列出涉及的模块、服务和文件及其路径。没有路径的部分在此仓库中不存在。 3. **追踪流程** - 用纯文本描述数据流和控制流,并为每个关键跳转引用 file:line。 4. **说明权衡** - 列出被拒绝的备选方案以及每个方案为什么落选。没有权衡的文档只是描述,不是决策记录。 5. **命名故障模式** - 对每个组件,说明如果它失败会破坏什么,以及什么会注意到。如果没有任何监控它,这本身就是发现。 6. **对照代码验证** - 将每条论断读回仓库核对。当文档和代码不一致时,修正错误的一方并说明是哪一方。 7. **为下一位读者格式化** - 使用标题和列表,并添加一段简短的“当此发生变化时”说明,列出什么会使本文档失效。 ## 验证 - [ ] 文档中的每条论断都与仓库中的一行匹配。 - [ ] 列出的每个组件都有真实文件路径。 - [ ] 已记录被拒绝的备选方案以及每个方案落选的原因。 - [ ] 每个组件的故障模式及其监控均已命名。 - [ ] 文档更新现有文件,而不是创建平行文件。 ## 规则 - 绝不要记录仓库中不存在的组件。 - 绝不要描述你尚未在代码中追踪过的流程。 - 绝不要留下无人监控的故障模式;明确说出缺失的监控。 - 如果代码与文档矛盾,修正文档或代码,而不是把两者都描述为真实。 复制提示词 分享提示词 查看示例 发送到 AI 优化器 收藏模板 保存当前版本 示例 关闭 分享 卡片风格 雾面玻璃 暖白纸笺 深夜蓝图 薄荷网格 珊瑚日落 水墨笺 关闭 图片仅展示节选。