Got your attention? That’s right, we believe that in an ideal world technical documents would be written by engineers.
In this fantasy world:
- Support engineers would write User Manuals, Installation Guides andTroubleshooting Manuals
- Product Managers would write Product Specifications
- System Architects would write System Specifications
- Developers would write SDKs, Technical Specs and MIBs
- And so on…
Ah, but we don’t live in an ideal world. We all know what can happen when an engineer is tasked with writing a technical document (if you don’t, then remind me when we meet and I will tell you some horror stories). And even when they are skilled at the art of technical writing, they are rarely available to put time into it.
But how can non-engineers write high-quality technical documents if they are not familiar with the material?