Introduction[ edit ] What is included in your introduction will depend on what your instructions are for and who will be using them. In any case, the introduction should be brief, but still informative.
Identify their level of technical knowledge Identify how they will use the guide Audience Definitions In the planning process, develop an audience definition that identifies: The user The system The tasks Software is used to do specific things. Users want to know what the software can do for them, for example, how to print a page in landscape.
They are generally not interested in the nitty-gritty technical details; they want to click a button and get a result. The User Guide is to teach them how the software helps them to do something. Depending on the guide in question, you may need to address several audiences.
Programmers who will troubleshoot the program IT Managers who want to know the resources the program requires Project Managers who want to confirm that the original requirements were met.
If you are writing for more than one audience, develop an audience definition for each one. Examine the definitions and see if you can address all audience types with one document.
In many situations, you may need to write a number of documents, of which the users guide is only one. When planning, use the audience definition to focus your decisions. When writing, the audience definition serves as a guide for the documentation team and as a benchmark for evaluating the results.
Here are some questions that will help define your audience's needs: Where will they use the document, for example, in the office, at home, in their car?
How much experience have they of using your application? Is this guide an upgrade to an existing application? Is your application new?
If so, you may want to include a Getting Started document to introduce the software. How will they use the user guide? Will they install the software by themselves or do so over the internet?
What level of detail is required? Will graphics help their understanding of how to use your product? Writing the User Guide Each user guide is comprised of front page, body sections, and a back page.
The following section describes what each of these needs to contain. Front Page cover pages Include a cover page, table of contents, and a preface, if necessary.
Cover and Title Page If the user guide is copyrighted, include a copyright notice.The Technical Writing Process is a simple, five-step process that can be used to create almost any piece of technical documentation such as a user guide, manual or procedure.
The writing process is the series of actions required to produce a coherent written text. It is a key term in the teaching of writing.
The 7 Rules for Writing World Class Technical Documentation. facebook; Also, I've added at no extra charge to you, the consumer, a bonus section at the end that describes the process I use to create a piece of technical writing.
Okay, so here are the 7 Rules: Writing a technical document without using an outline is like trying to. Apr 20, · Be aware of the skills required to be a technical writer.
Unlike creative writing or opinion based writing, technical writing should help a reader understand a process, product, or subject in a clear and concise way.
Online Technical Writing: Contents Free Online Textbook for Technical Writing. Technical writing is one of the most important activities undertaken by an engineer, with the content often being safety-critical or business critical. It is therefore worthwhile considering how to improve the quality of documents and the efficiency of the writing.