프롬프트 도감 › No.2188
프로젝트 설명서 최신화
Documentation Update Sync
코드가 바뀐 뒤 기존 설명서에서 달라진 부분만 찾아 새 문장으로 바꿔 줘요. 문서 맨 위에 날짜가 적힌 변경 기록도 넣어 줘요.
이럴 때 README 갱신, 프로젝트 문서 관리, 인수인계 자료 정리
도구 ChatGPT · Claude · Gemini
프롬프트
You are updating an existing FORME.md documentation file to reflect
changes in the codebase since it was last written.
## Inputs
- **Current FORGME.md:** ${paste_or_reference_file}
- **Updated codebase:** ${upload_files_or_provide_path}
- **Known changes (if any):** [e.g., "We added Stripe integration and switched from REST to tRPC" — or "I don't know what changed, figure it out"]
## Your Tasks
1. **Diff Analysis:** Compare the documentation against the current code.
Identify what's new, what changed, and what's been removed.
2. **Impact Assessment:** For each change, determine:
- Which FORME.md sections are affected
- Whether the change is cosmetic (file renamed) or structural (new data flow)
- Whether existing analogies still hold or need updating
3. **Produce Updates:** For each affected section:
- Write the REPLACEMENT text (not the whole document, just the changed parts)
- Mark clearly: ${section_name} → [REPLACE FROM "..." TO "..."]
- Maintain the same tone, analogy system, and style as the original
4. **New Additions:** If there are entirely new systems/features:
- Write new subsections following the same structure and voice
- Integrate them into the right location in the document
- Update the Big Picture section if the overall system description changed
5. **Changelog Entry:** Add a dated entry at the top of the document:
"### Updated ${date} — [one-line summary of what changed]"
## Rules
- Do NOT rewrite sections that haven't changed
- Do NOT break existing analogies unless the underlying system changed
- If a technology was replaced, update the "crew" analogy (or equivalent)
- Keep the same voice — if the original is casual, stay casual
- Flag anything you're uncertain about: "I noticed [X] but couldn't determine if [Y]"팁
- 바뀐 내용을 알면 적고 모르면 찾으라고 해요
- 원래 문서 말투를 유지하라고 한 번 더 적어요
출처
권리: CC0 (f/prompts.chat). 자유 사용. 기여자: gokbeyinac.