developer coding template risk: low

FORME.md Codebase Update Documenter

The prompt directs the model to compare current FORME.md documentation against an updated codebase, identify changes, assess impacts on sections and analogies, produce replacement…

PROMPT

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]"

INPUTS

paste_or_reference_file REQUIRED: Current FORME.md file content or reference
upload_files_or_provide_path REQUIRED: Updated codebase files or path

REQUIRED CONTEXT

Current FORME.md
Updated codebase
Known changes

ROLES & RULES

Role assignments

You are updating an existing FORME.md documentation file to reflect changes in the codebase since it was last written.

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]"
Do NOT rewrite the whole document, just the changed parts

EXPECTED OUTPUT

Format

markdown

Schema

markdown_sections · Changelog Entry, Section Replacements (e.g. ${section_name} → [REPLACE FROM "..." TO "..."])

Constraints

Provide REPLACEMENT text only for changed parts using format: ${section_name} → [REPLACE FROM "..." TO "..."]
Do NOT rewrite unchanged sections
Include dated changelog entry at top
Maintain original tone, analogies, and style
Flag uncertainties

SUCCESS CRITERIA

Compare documentation against current code
Identify new, changed, and removed elements
Assess impact on FORME.md sections
Produce replacement text for affected sections only
Add new subsections for new features
Include dated changelog entry at top

FAILURE MODES

Rewriting unchanged sections
Breaking existing analogies unnecessarily
Altering original voice or style
Failing to flag uncertainties
Overwriting the entire document

CAVEATS

Dependencies

Current FORME.md file
Updated codebase files or path
Known changes description

Missing context

Definition or example of FORME.md structure and style (e.g., 'crew' analogy details).
Mechanism for accessing '${upload_files_or_provide_path}' in the environment.

Ambiguities

Typo: 'Current FORGME.md' vs title 'FORME.md'.
Unspecified source or format for '${date}'.

QUALITY

OVERALL: 0.90
CLARITY: 0.95
SPECIFICITY: 0.90
REUSABILITY: 0.95
COMPLETENESS: 0.85

IMPROVEMENT SUGGESTIONS

Fix typo: change 'Current FORGME.md' to 'Current FORME.md'.
Specify date format: e.g., 'Use YYYY-MM-DD for ${date}'.
Add example output snippet for replacement format.
Clarify handling of large codebases or unknown changes.

USAGE

Copy the prompt above and paste it into your AI of choice — Claude, ChatGPT, Gemini, or anywhere else you're working. Replace any placeholder sections with your own context, then ask for the output.