User Manual Maintenance (/update-manual)¶

In plain terms

Keeps the user manual up to date whenever a change affects what users see or do.

What this skill does

Ensures the user manual is updated whenever functional changes affect the user experience

[!TIP] Use whenever you implement a user-facing feature, change a UI flow, or modify logic that impacts how users interact with the system.

Trigger Conditions¶

Keywords: "Add a feature", "Change UI", "Update logic", "New field", "Modify flow", "Bug fix (user-facing)"
Files: Changes to components, pages, or complex business logic

[ ] Impact Assessment: What has changed from the user's perspective? (Ignore technical details — think "what will users need to know or do differently?")
[ ] Section ID: Identify which section(s) in docs/general/MANUAL.md are affected
[ ] New Sections: Determine if an entirely new section or chapter is required

[ ] Clarity: Write instructions in plain English — avoid technical jargon ("API", "Database", "React", "hook")
[ ] Visuals: Note if existing screenshots or UI descriptions need updating
[ ] Consistency: Match the tone of the existing manual (instructional, user-facing)

[ ] Edit: Open and edit docs/general/MANUAL.md directly
[ ] Formatting: Use proper markdown headers and lists
[ ] Manual Version: Increment the **Manual Version** line at the top of the manual:
Minor changes (corrections, clarity): bump Y.Y → Y.Z
Major changes (new features, new sections): bump X.Y → (X+1).0
[ ] Sync: Run the appropriate sync script:
Minor changes: cd backend && npm run sync-manual:dev
Major changes: cd backend && npm run sync-manual

[ ] Review: Read the updated section — is it helpful and accurate for a non-technical user?
[ ] Cross-Reference: Ensure any links to other parts of the manual still work
[ ] Release Notes: If this is a significant change, update docs/general/RELEASE_NOTES.md (or run /release-notes)