Technical writing

Peann has been providing technical authoring services for 10 years; writing specifications, manuals and reference documentation for a global customer base. Documents can range in size and complexity from a simple one-page release note to an API reference manual of hundreds of pages.

Clients have included large corporations such as Nortel Networks, global brands such as Skype and innovative startups like OpenX, an open-source ad server that is revolutionising the online advertising industry.

Typically, our process is to work with your product team to research the requirements. We then draft a documentation plan which identifies content areas, milestones and deliverables, information and review requirements and any anticipated issues or dependencies. When the plan is approved we get to work:

• Using the product is essential to understanding the needs of the target audience.
• Good lines of communication are essential and we like to clarify tools and processes at the outset: SVN, bug-tracker, wiki, IM groups and project meetings.
• Researching and writing content can include pestering subject matter experts with questions until all of the pieces of the jigsaw are in place. If something doesn't make sense to us, it is likely that it will not make sense to the reader.
• Screenshots and illustrations can help explain things quickly to new users. However, images should be used carefully, because they can be high-maintenance whenever your product changes, and can add significantly to localisation costs if you plan to translate your documents.
• Forewarned is fore-armed and we like to liaise closely with testers and developers to have a clear understanding of project status and issues.