How To Maintain Docs

Use this when: you are closing a sprint, adding a module, or correcting stale documentation.

Documentation maintenance is part of the delivery workflow. Every sprint must update relevant docs, and every new module needs operating guidance before manager onboarding or staging review.

Maintenance Rules

1. Update module docs when workflows, permissions, statuses, routes, or safety boundaries change.
2. Add or update runbooks when an operation becomes repeatable.
3. Keep sprint notes accessible, but do not let them replace permanent operating guides.
4. Mark stale docs as Needs Review.
5. Create a System QA or Data Quality issue where practical when a stale doc can confuse staff.
6. Never include secrets, passwords, private imports, real customer exports, or production credentials.

Review Cadence

Permanent operating docs should be reviewed at least every quarter. Sprint notes can be archived after the sprint is accepted, but they should remain searchable for audit history.

New Module Checklist

1. Overview.
2. Workflow.
3. Permissions.
4. Data model or reference page.
5. Safety boundaries.
6. Local/staging test notes.
7. Related app routes.
8. Related docs.