Technical writing is the skill of explaining complex terms in plain English, to both technical and non-technical audiences. The skill of technical writing requires a command of language and the ability to understand new concepts quickly. A technical writer need not be an expert in the field in which they are writing. In fact, it is often an advantage to approach a technical writing project with a completely fresh outlook, as it enables the technical writer to see the concepts as a lay person would and therefore perceive the types of things a lay person is likely to have trouble understanding.
At NetSavvy we are skilled in understanding complex concepts quickly and explaining these ideas in easy to understand terms. Our attention to detail is second to none and will ensure an accurate, clear, concise and unambiguous document.
In preparing a document we will:
- Assess the type of audience at which the document is aimed, to understand their needs and their level of technical understanding and expertise. In this way the document is tailored to a specific audience.
- Gather information for the document by studying existing material and interviewing experts in the field.
- Plan the structure and layout of the document.
- Prepare the content of the document.
- Submit the document for review by an expert, or panel of experts, in the field.
- Update the document according to the results of that review.
- Release the document for use.
The types of documents we can prepare are:
- user documentation. such as
- user manuals
- online help
- release notes
- troubleshooting guides
- tutorials
- software installation guides
- technical documentation, such as
- maintenance guides
- repair manuals
- engineering specifications
- articles written for technical journals
- standard industry contracts (with the help of a legal professional)
- grant applications