Technical writing examples for definitions, warnings, config docs and code comments

Technical writing isn't only long manuals. Most of it is small. A one line definition in a glossary. A warning box above a dangerous command. A description beside a config option. A comment above a tricky loop. These bits get read at the exact moment someone is about to make a mistake, so the wording matters more than its length suggests. This... Weiterlesen: Technical writing examples for definitions, warnings, config docs and…