Successful Documentation Projects Part 3 of 3 Writing
So you understand your user documentation project and youve specced it out. Now youre ready to write. Heres some tips to help you on your way. This article isnt about the actual writing itself; its about the things which go along with the writing.
NOTE: This is the final article in a series of three outlining the key elements of a good user documentation process.
Indexing
Index keywords should be defined while the topic is being written. At this time, the subject matter is clear in the authors mind, and they are very conversant with all of the intricate details. Indexing during the writing stage also means that your keywords are reviewed as part of the draft process.
Some authoring tools dont really facilitate this kind of approach particularly well (e.g., some dont allow multiple author access to the files needed for indexing), but at least the keywords should be listed at the end of each draft. (Depending on the authoring tool, this may actually be easier for the reviewers, anyway.) TIP: For further information on indexing, see The Art of Indexing (1994) by Bonura.
User...
To view and download this full PLR article, you must be logged in. Registration is completely free. Once you create your account, you will be able to browse, search & downlod from our PLR articles database of over "1,57,897+" on 1,000's of niches and 200+ categories without paying a penny. Click here to signup...
