|
|
|
|
|
by 532nm
1473 days ago
|
|
A neat guide for good technical writing goes as follows: 1. Tell the 'WHAT' (i.e what you have built/observed/intend to do/etc.) 2. Explain the 'SO WHAT' without which the WHAT is almost meaningless (i.e. that it reduces operating costs by X/.../etc.) I often find myself focusing too much on the WHAT, neglecting the SO WHAT. However, the succinct phrasing helps me to also keep the SO WHAT in mind. (I first stumbled upon this way of phrasing things in the neat little book 'Trees, Maps and Theorems' by Doumont) |
|
Another good writing tip: replace every “and then” transition with a “and that’s why” or “and despite that” transition