For every major documentation project we take a two-pronged approach to ensure that you get the most accurate content possible. One of us will lead the project with another testing. Here’s how it works:
- The project leader will chat with you about what sort of documentation you want and what you want to achieve with it. We’ll also discuss your target audience, the tone you would like to adopt and how you would like the content to fit within your overall branding.
- The leader will spend some time getting to know your product. If you have no documentation at all this may involve spending some time walking through the product with the developer so we have a full grasp on it.
- We’ll start writing your content. Throughout the process we’ll keep you up-to-date and contact you with any questions as they arise. We use a number of different tools while writing, including Jumpchart for creating web content wireframes, and both local and remote WordPress installations to create tutorials.
- The content will be properly formatted, either on your website as a draft or in any other file format that you require.
- The content will be passed to the project tester. This is an important part of the process for documentation, sales and tutorials (you may want to skip it for blog posts and articles). The tester has not had any experience with the product so they will be approaching it as an average WordPress user. They will test for the following:
- Meaning – does the content convey the concept in a way that is easily understood?
- Clarity – are all difficult concepts and jargon made clear?
- Logic – do the steps of a tutorial follow logically from one another?
- Practical Application – can a tutorial easily be followed with the results properly created?
- Usability – is documentation usable by and relevant to WordPress users of all levels?
We will also submit bug reports, typographical error reports and usability reports. We have our own forms for these but can use your own should you have them.
While we are open to discussing different working methods with you, we’re confident that by following this method we will be able to provide you with the best content possible for your WordPress product.
