Area IX
Technical Communication Formats
Shapes that make information usable
The same facts serve a reader well or badly depending on their arrangement on the page. Lead with what matters, strip everything that does not serve the task, break lines by meaning so version control stays legible, and cast procedures as clean imperatives. Format is not decoration; for working documents it is most of the usability.
-
Semantic Line Breaks
One clause per line
Break source lines at clause boundaries so diffs and reviews stay clean.
-
Inverted Pyramid
Most important first
Order a whole document from most to least important so it can be cut from the bottom.
-
Minimalist Instruction
Action first, cut the rest
Strip instructional prose to the actions a reader must take, removing everything else.
-
Procedural Imperative Voice
Numbered, do-this steps
Cast procedures as numbered imperative steps, one action each.
Example from this area
From Semantic Line Breaks—Break source lines at clause boundaries so diffs and reviews stay clean.