Preview Page: Editorial Standards
A sample standards page covering clarity, accuracy, and useful technical explanations.
Last updated:
Write for understanding
Technical writing should define unfamiliar terms, explain assumptions, and make the reasoning behind a recommendation visible.
Prefer concrete examples and distinguish measured results from opinion or expectation.
Review with care
A review should check correctness, attribution, accessibility, and whether the article answers its stated question.
When a claim depends on a specific version or environment, include that context so readers can assess whether it applies to their situation.