soukupl Keep documentation current
Documentation drift is a bug. When behavior changes, the docs describing it change in the same piece of work — not "later".
What to keep in sync (only what exists / is warranted)
- README — setup, install, run, and the headline feature list.
- Usage / API docs — public functions, endpoints, CLI flags, config keys, env vars.
- CHANGELOG — user-facing changes, if the project keeps one.
- Inline docs — doc comments on public surfaces you changed; keep them factual, not decorative.
How
- After a change, ask: "what did I make true or false?" Find the docs that assert the old behavior.
- Update them to match. Add docs for genuinely new surfaces.
- Match the project's existing doc style and location — don't invent a new docs system.
- If a change is user-visible but undocumented anywhere, say so and propose where it should live.
Restraint
Don't over-document: no docs for obvious internal helpers, no restating code in prose, no giant files for a tiny project. Right-size to the project. Documentation you add must be correct — verify commands and examples actually work before writing them down.