Technical Writing
Keep it simple, stupid
Technical writing is the presentation of information that helps its reader solve a particular problem. Technical communicators write, design, and/or edit proposals, manuals, web pages, lab reports, newsletters and many other kinds of professional and technical documents. Technical writing is usually concerned with presenting information of a technical nature to a specific audience. In most cases, it is necessary to take complex ideas or terminology and present them in such a way as they are comprehenisble to a nontechnical reader, such as product documentation. This is not always the case, for example, in academic writing where the target audience are likely to be experts in the subject matter, but, it is still important to ensure the writing is accessible and accurate.Examples of technical writing:
- Product documentation
- Help manuals, instruction manuals and installation manuals
- Design specifications
- White papers and journal articles
There are several steps involved in technical writing. A preliminary review and evaluation of the product or existing documentation is carried out to scope out the key requirements. An interview with the expert (e.g., creator of the product, computer programmer etc.) on the subject matter is then performed. It is also necessary to identify accurately the intended audience, in order that the style of writing is appropriate. Documentation writing can then commence, which involves several review and consultation phases.
I offer a complete on-site package tailored to your needs and the specifics of the document to be prepared. As required, I produce all necessary deliverables, such as original imagery, stock imagery, data presentation and slideshows. Indeed, a complete product or information website can be supplied.
2000-2008. ¤