Technical writing is used in many different ways to help an individual solve a problem. Different forms of technical writing include proposals, manuals, web pages, lab reports and many other professional documents. Technical comes from the Greek word techne, which means skill.
First, establish what kind of documents you plan to create. Some examples include: product descriptions, installation guides, configuration guides, maintenance procedures, online help, error messages, notifications, tooltips. When you are writing tooltips, notifications, or error messages, be clear, concise, and grammatically correct, keeping the format consistent. Finally, decide whether the document will be provided on paper, CD or integrated with the software.
While writing your document, make a list of glossary terms. Research these terms to create your definitions. When your draft is complete, use the spell check and review your work from cover to cover. Send your document to a subject matter expert to review the accuracy of your work. Once your document is in its final stages, ask a friend who has limited knowledge of the subject to review it, ensuring that it is understandable to the average person.
"The Technical Writing Process." Technical Writing Tips for Technical Writers and Managers of Writers. 04 Apr. 2009 http://www.docsymmetry.com/technical-writing-process.html.
"Technical Writing: What is It?" Dennis G. Jerz. 04 Apr. 2009 http://jerz.setonhill.edu/resources/FAQ/TW.htm.