How to write technical documentation
Write clear, consistent technical documentation with practical guidance on voice, structure, terminology, and tone for developer and product docs.
Was this page helpful?Suggest editsRaise issue
On this page
Write in second personUse active voiceKeep sentences and paragraphs shortUse headings that match user intentUse consistent terminologyCalibrate tone to your audience and content typeAvoid common mistakesJargon and internal terminologyInconsistent capitalizationColloquialismsSpelling and grammar errorsEnforce standards with toolingFrequently asked questionsRelated pages