Writing Techniquesλ︎
Technical writing techniques focus on simplifying complex information with clear and unambiguous words, which an audience can find and effectively consume.
Significantly sized document body should be structured logically.
Writing Stylesλ︎
Companies involved in publishing documentation have their 'house style', a set of guidelines on how to convey information with words and imagery.
There is no one-true writing style.
A technical writing style guide documents the rules for voice, grammar, formatting, terminology, and structure so your content stays consistent across people and time.
When documentation lives in multiple places (docs site, help center, in-product UI), the style guide keeps everything aligned.
A style guide is not a replacement for product knowledge, user research, or good information architecture.
A “minimum viable style guide” typically includes:
- formatting standards: headings, code, UI labels, links
- review ownership: who approves changes
- terminology standards: what words mean what
- voice: who you are, who you are talking to
Etymologyλ︎
Etymology is the study of the origin and evolution of words—including their constituent units of sound and meaning—across time.
As a subfield within linguistics, etymology has become an increasingly rigorous scientific field of study.
Understanding how words evolved and how interconnected they are help you be more expressive.
Words Unravelled YouTube Channel
Jess Zafarris/){target=_blank .md-button}