prime-radiant-inc/maintaining-documentation
Keep a project's docs true to the code and useful to their readers, without rewriting historical records.
Use when copyediting or tightening the prose of documentation (README, guide, tutorial, troubleshooting, reference, architecture doc) whose content is already settled, or when a doc reads as wordy, passive, or vague.
Use when documentation needs writing, checking, or maintaining — writing a README, tutorial, how-to, troubleshooting guide, reference, architecture doc, or onboarding doc; docs that read like a code tour; docs that may have drifted from code; pre-release doc verification; updating docs after finishing code work; adding or enforcing project terminology; deciding where a new doc should live; or a routine re-audit of previously verified docs.