Update/Sync Prompt

Documentation Update Task

You have been assigned to update an existing technical documentation file (FORGME.md) to accurately reflect the changes made to the associated codebase since the last documentation update.

Context and Inputs

Documentation State

• Current FORGME.md: ${paste_or_reference_file}
• Format: Markdown (.md) file
• Purpose: To provide a high-level overview and detailed technical description of the system, using analogies to make complex concepts accessible
• Audience: New team members, external developers, and product stakeholders

Codebase State

• Updated Codebase: ${upload_files_or_provide_path}
• Changes: The codebase has been modified since the FORGME.md was last written
• Known Changes: [Provide specific details if known, or indicate "Unknown changes"]

Documentation Goals

• Maintain the existing tone, style, and analogies
• Ensure the documentation remains accurate and relevant
• Avoid rewriting sections that haven't changed
• Flag any uncertainties for further clarification

Your Tasks

Phase 1: Analyze and Identify Changes

1. Diff Analysis: Compare the current FORGME.md against the updated codebase.

   • Use a diff tool (e.g., Git diff, Visual Studio Code's diff view) to identify changes
   • Focus on changes to files and functions mentioned in the documentation

2. Impact Assessment:
   For each identified change, determine:

   • Which specific sections of FORGME.md are directly affected
   • Whether the change is superficial (e.g., file renaming) or structural (e.g., new data flow)
   • If existing analogies remain valid or require updating
   • The potential cascading effects on other sections

Phase 2: Produce Updated Documentation

3. Affected Section Updates:
   For each section that requires modification:

   • Write the new text that replaces the outdated content
   • Format it clearly as a replacement: ${section_name} → [REPLACE FROM "..." TO "..."]
   • Maintain the original document's tone, style, and level of detail
   • Ensure the updated section remains aligned with the overall system description

4. New Additions:
   If entirely new systems or features have been introduced:

   • Write new subsections following the same structural format
   • Integrate these additions at the appropriate location in the document
   • Update the "Big Picture" section if the overall system description needs adjustment

5. Changelog Entry:
   Add a dated entry at the top of the FORGME.md file:

   phpCopy

   ### Updated ${current_date} — [One-line summary describing the most significant change made]

Phase 3: Final Review

6. Consistency Check: Ensure the updated document remains consistent in tone, style, and terminology
7. Accuracy Verification: Confirm that all changes in the codebase are accurately reflected in the documentation
8. Uncertainty Reporting: Clearly indicate any areas where you were unable to determine the precise change or its documentation implications

Constraints and Guidelines

• Avoid rewriting content that hasn't changed
• Maintain the original document's purpose and audience
• If a technology has been replaced, update the corresponding analogy or use a new one
• If an analogy no longer works, suggest an alternative or flag it for review
• Keep the documentation up-to-date without introducing errors or inconsistencies

Please provide your updated documentation, following the format and guidelines outlined above. If you have any questions or need further clarification, please don't hesitate to ask.