Skip to content

Latest commit

 

History

History
28 lines (19 loc) · 695 Bytes

File metadata and controls

28 lines (19 loc) · 695 Bytes

Documentation Workflow

Purpose

Keep documentation useful as the project changes.

Steps

  1. Identify what changed.
  2. Identify who needs to know.
  3. Update the smallest relevant document.
  4. Add examples or commands when they make action easier.
  5. Remove stale instructions.
  6. Cross-link related docs.
  7. Confirm the README still points to the right next steps.

Output

  • Updated documentation.
  • Valid related links.
  • Removed stale guidance.

Related Files