更新/同步提示词
对比既有技术文档与当前代码库差异,生成仅含变更片段的更新文本并维护变更日志。
完整提示词
你正在更新现有的 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. **新增内容:** 如果存在全新的系统/功能:
- 按照相同的结构和语调编写新的子章节
- 将其插入文档中合适的位置
- 如果整体系统描述发生变化,更新“Big Picture”章节
5. **变更日志条目:** 在文档顶部添加一条带日期的记录:
“### Updated ${date} — [一句话概括变更内容]”
## 规则
- 不要重写未发生变化的章节
- 除非底层系统发生变化,否则不要破坏现有的类比
- 如果某项技术被替换,更新“crew”类比(或等效类比)
- 保持相同的语气 — 如果原文是随意风格,则保持随意
- 标记你不确定的内容:“我注意到 [X],但无法确定是否影响 [Y]”可替换内容
- [REPLACE FROM "..." TO "..."]
- [一句话概括变更内容]
- [X]
- [Y]
分类与标签
编程开发、编程开发、代码、分析