How to Leverage Technical Writing to Foster Software Success: from Pain to Great User Experience

For product managers and software engineers, technical writing can be much more than documentation

Luca Vettor
ILLUMINATION

--

Author’s mind map

Many software companies underrate technical writing because ‘it’s just documentation.’ Even when product managers realize that clients need written guidance, they often don’t allocate a budget for a technical writer and burden software engineers with writing tasks. The product is made up of software, not documents! — they think.

The truth is that product managers are right when they do their best to avoid delivering technical documentation. However, their typical approach is wrong because they assume that documentation is an obligation, not a design tool. As a result, they fail to use technical writing to improve their product and try to minimize what they deem a mere cost.

On the other hand, technical documentation is that part of the human-machine interaction that nobody desires: the materialization of the effort users must make to understand the software. Users prefer seamless experiences! Think of you as a user: how much do you enjoy reading instruction manuals? Likely, zero. If so, technical documentation shouldn’t bother you!

--

--

Luca Vettor
ILLUMINATION

My 24 years in the IT industry and physics degree flow into my mission: simplify what appears complex.