Know the Software
- Training
Make sure you receive proper training for the software that you are about to document and that you have the software explained to you, step by step. - Experiment Have the software installed on your machine; make sure you also have access to as much as possible of the necessary software related information, and that you have access to all the functionalities of the software. Explore all its functions, and don’t be afraid to ask the engineers whenever you are not certain about the influence of, let’s say, an unchecked checkbox or radio button on the process that you are documenting. Don’t assume anything, you could be wrong.
- Gather information
This may mean older documents, definition documents for certain functionalities or specifications, general PowerPoint presentations, marketing documents, etc. They may help you along the way.
Identify the Target Audience
This is of utmost importance. You have to know beforehand what kind of public the document you are about to produce addresses to, so that you know how to adjust and adapt the style and the informational content of the document. Again, ask the engineers, the product managers, about the audience. You don’t want to be too technical for a non-technical audience, or vice versa.
Leave a Reply
You must be logged in to post a comment.