Technical writing

Choose tutorial for guided learning, how-to for a concrete task, reference for lookup, or explanation for understanding. Mixed documents use separately purposed sections. Establish audience, task and available source evidence; infer routine choices and ask only material unknowns.

Lead with the useful outcome. Preserve uncertainty, technical terms, user stance, code and quoted errors. Tutorials include visible expected results and recovery where relevant. Use the smallest useful diagram/table; no mandatory diagram count, modal ban or sentence-length constraint. Verify source-backed statements and label inference. Public writing does not copy private voice examples.

Completion: the reader can act or understand from the document, supported claims retain evidence and unresolved facts remain visible. Optional style enrichment cannot override factual accuracy.