Writing Good Docs

Writing Good Docs

Short version here — for the full how-to (structure, templates, style), see Guide for Writing Documentation.

Why it matters: docs save training time and prove we actually understand what we build. Write as you go, online, where others can review.

• Online, not local. Put it in Confluence so people can find and review it.
• Write for the next person. Assume a new joiner — explain the non-obvious, skip the obvious.
• Say why, and who decided — the reasoning behind a choice, not just the what.
• One thing at a time, and keep it current. Update the doc when reality changes; stale docs mislead.
• Show, don't just tell. A screenshot, a worked example, the actual command or settings.
• Short and scannable. Headings, short bullets, plain language. Done beats perfect.

Full guide: Guide for Writing Documentation.