Method. Experience. Diligence.
A simple three part method solves all technical writing dilemmas by taking the input material, considering the audience from a user-centred approach, and formulating output material. A five step process can be used to design and complete longer or more complex documents such as user manuals.
Get in touch to have a longer conversation about this and outline your requirements.
Having a technical writer who’s not a subject matter expert is an advantage.. here’s why
Normally a subject matter expert (SME) has the job of being immersed in their expertise. They may not have time to write technical documents, and it can be hard for them to switch out of the expert mindset they need for their job, into a beginner’s mindset to write simple explanations.
A technical writer coming in to write documentation needs to ask a series of questions to clearly understand the subject matter, and when they do this, it tells them what questions the audience will be asking, when they are seeking to understand. Assuming little or no background knowledge is the best start to understanding how a lay audience might think. User research and insights are another way to gain more specific audience knowledge.
Successful technical writing is about being accurate .. and it’s about conveying the required information and knowledge to the audience, efficiently.
Using plain English helps the audience understand more clearly .. and ultimately be happier
Every time someone reads something they don’t understand, they have to stop and wonder what it means. In neuroscience this is known as task switching and it takes cognitive energy as well as time.
By using plain English, the audience can read through smoothly and at their own pace to understand written material and instructions and then they know what do more quickly. This also encourages people to talk to each more, building their own knowledge and sharing with others.