All about successful documentation projects
So you are responsible for handling a documentation project. You know that the audience is, what they are trying to accomplish, the way the item permits them to achieve this, and what the viewer needs of this aid. Now it is time to spec out your aims. This is actually the second in a string of three articles outlining the essential elements of a fantastic user documentation procedure. Generically speaking, your Objective Statement must indicate that you aspire to make a package of documentation products which will satisfy audience prerequisites. Especially, you will have a range of sub-goals. TIP. It might help to keep in mind that the goals that you put here will have to get utilized to assess the achievement of your product via your very own in-house testing in addition to through evaluative user search
Your goals place, you can begin to consider what you are likely to create. The very first step would be to produce a few concept specifications. In other words, theories specs are extremely large level overviews of everything you are suggesting to create. By way of instance, your concept spec to your online help may say you will be creating something which enables the user to get information by means of a TOC, an Index, and a Locate. It may indicate some potential GUI characteristics of those components, but it would not lay down requirements. only chances. The concept spec to your guides might say that they will be professional appearing, will comprise many professionally drawn images, will have sufficient white space, will soon be trendy, and will be broken into chapters to coordinate with the task oriented character of the internet assistance. Usually, the product you are Indicating can be implemented in several of different ways.
Now that you have decided roughly what you want to create, you are able to design some probable implementations of it. Your layouts will be quite large level and they might not really work they might actually be paper prototypes. Together with most other factors already finalized through your consumer needs study, these implementations you Want to know as much as Potential about these items, so as to ascertain what really possible, effective is, powerful and have a try at intelligent document processing software. You ought to know about current trends, literature, white papers. This info can be obtained from an assortment of sources. Model prototype your layouts for the decision makers and viewers samples. This permits you to select the best characteristics from each layout and also to determine priorities for them. Pick a layout or merge a number of layouts that you think best matches user needs. This procedure may be iterative. In the conclusion of the point, you ought to know enough to detail just what you will be generating including what aid platform and instrument you will be using.