Documentation & technical WritingNeed expert assistance with your software documentation? Our writers understand research technology and practices inside out.
How we create really good documentation and training resources
We will start by creating an overall plan, taking into account any resources you already have. We will think holistically about what resources different audiences require, from new users through to experienced product champions.
Importantly, we will relieve your developers of the burden of writing user documentation. Because we too have a technical background, we can work efficiently with them, often using the internal source documentation they have created. But we will leave you with materials you will easily be able to maintain in-house using your own resources.
We will work flexibly within the budget you have, prioritising the materials you most need to get started.
Appealing, branded materials
Documentation should of course aid the use of the product – but we are also keenly aware that it is a key part of the product and company image, so presentation style is important. We will work to your organisation’s house style (writing and presentation styles). If you require assistance with developing a house style guide for your technical documentation, we can also provide this.
Our approach is to make the writing almost invisible so that it is the content that makes an impact on the reader. Clarity comes from taking care over what we present, how we organise the material and over how much we say (less is usually more, here). Clarity also comes from how we craft examples that perfectly illustrate each point without adding clutter.
We write from the perspective of the user, not merely about what the software does, but how they apply it to the work they need to do. We don’t use jargon or make assumptions. We make sense of a mass of detail by giving it structure and context.
We have decades of combined experience in writing market research software technical documentation, and knowledge of market research terminology and the market research process.
We have experience of producing documentation on a number of documentation platforms and can provide recommendations on the best approach to take.