Meryam Sahin (talk | contribs) m 1 revision imported |
Meryam Sahin (talk | contribs) No edit summary |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
Good documentation helps people make decisions, repeat work, and understand context without relying only on meetings or private messages. | |||
== Write for the next reader == | == Write for the next reader == | ||
Assume the reader is capable but missing context. Explain the purpose of the page, define uncommon terms, and link to related information. | |||
Assume the reader is capable but missing context. Explain the purpose of the page, define uncommon terms, and link to related | |||
== Keep structure predictable == | == Keep structure predictable == | ||
Use clear, descriptive headings and a consistent structure. For longer pages, use sections and a table of contents to help readers find what they need. | |||
Use | == Use tables when they help == | ||
Tables work well for comparisons, roles and responsibilities, decision options, and checklists with owners. Use normal text when information is easier to read as paragraphs. | |||
== Use tables when | == Keep information current == | ||
Important operational pages should have an owner or owning team and should be reviewed regularly. The owner does not need to make every update, but is responsible for keeping the information accurate. | |||
Tables | == See it in practice == | ||
The [[wiki-helpdesk:Main Page|Helpdesk]] provides examples of how practical guidance can be structured for people who need to find information quickly. | |||
[[ | |||
Latest revision as of 13:23, 17 August 2026
Good documentation helps people make decisions, repeat work, and understand context without relying only on meetings or private messages.
Write for the next reader
Assume the reader is capable but missing context. Explain the purpose of the page, define uncommon terms, and link to related information.
Keep structure predictable
Use clear, descriptive headings and a consistent structure. For longer pages, use sections and a table of contents to help readers find what they need.
Use tables when they help
Tables work well for comparisons, roles and responsibilities, decision options, and checklists with owners. Use normal text when information is easier to read as paragraphs.
Keep information current
Important operational pages should have an owner or owning team and should be reviewed regularly. The owner does not need to make every update, but is responsible for keeping the information accurate.
See it in practice
The Helpdesk provides examples of how practical guidance can be structured for people who need to find information quickly.
