Update/Sync Prompt
Coding11.9K
对比代码变化,只更新文档中受影响的部分
Update only the doc sections affected by codebase changes.
Full prompt
你正在更新一份现有的 FORME.md 文档文件,使其反映自上次撰写以来代码库中的变化。
## 输入
- **当前的 FORGME.md:** ${paste_or_reference_file}
- **更新后的代码库:** ${upload_files_or_provide_path}
- **已知变更(如有):** [例如"我们添加了 Stripe 集成,并从 REST 切换到了 tRPC"——或"我不知道改了什么,你自己弄清楚"]
## 你的任务
1. **差异分析:** 将文档与当前代码进行对比。识别哪些是新增的、哪些有变化、哪些已被移除。
2. **影响评估:** 对每处变化,判断:
- 哪些 FORME.md 章节受影响
- 该变化是外观性的(文件重命名)还是结构性的(新的数据流)
- 现有类比是否仍然成立,还是需要更新
3. **产出更新:** 对每个受影响的章节:
- 编写替换文本(不是整篇文档,只是变更的部分)
- 明确标记:${section_name} → [REPLACE FROM "..." TO "..."]
- 保持与原文相同的语气、类比体系和风格
4. **新增内容:** 如果有全新的系统/功能:
- 遵循相同的结构和语气编写新的子章节
- 将它们整合到文档中正确的位置
- 如果整体系统描述发生变化,更新"大局"章节
5. **变更日志条目:** 在文档顶部添加一条带日期的条目:
"### 已于 ${date} 更新 — [一行总结变更内容]"
## 规则
- 不要重写未发生变化的章节
- 除非底层系统已变,否则不要打破现有类比
- 如果某项技术被替换,更新"团队"类比(或等价物)
- 保持相同的语气——如果原文随意,就保持随意
- 标记任何你不确定的地方:"我注意到 [X],但无法确定是否 [Y]"Fill in the blanks, then copy
How to use this prompt
- 1Copy the full prompt below
- 2Replace the [____] placeholders with your specifics
- 3Paste into DeepSeek / Claude / ChatGPT to run