Latest posts by techwriter (see all)
- How to Number Your Documents Properly – A Document Numbering Strategy - April 24, 2017
- How to Avoid Repeating Words in a Headline - April 18, 2017
- Leveraging Multi-Function Printers With Document Imaging Software - April 10, 2017
© 2010 Ugur Akinci
Most of the time you’ll hear that short is good in technical writing and long is bad. That’s true in general.
But like everything else, this rule has an exception as well.
If you write in too many short sentences cascading one after the other, the readers will have a hard time reading and understanding your document.
BAD technical writing: “Press the button. A screen will display. The display will have the title VOLTAGE CONFIGURATION SCREEN.” (Not concise)
GOOD technical writing: “Press the button to display the VOLTAGE CONFIGURATION SCREEN.” (Concise)
BAD technical writing:“Make sure the configuration module is displayed first. Then find the Maximum Voltage field. Enter 120 Volts as a value into the Maximum Voltage Field. Once done with that, find the TBD radio button. Clear the TBD radio button.”
GOOD technical writing:“When the configuration module is displayed, type 120 Volts into the Maximum Voltage field and clear the TBD radio button.”