I am preparing documentation on a software product for my company. Can anyone provide me suggestions for preparing a better document will help me a lot. Are screenshots necessary while preparing the documentation ?
- Anybody can ask a question
- Anybody can answer
- The best answers are voted up and rise to the top
closed as unclear what you're asking by Phil Kirkham, Kate Paulk, corsiKa♦ Oct 10 '13 at 15:34
Please clarify your specific problem or add additional details to highlight exactly what you need. As it's currently written, it’s hard to tell exactly what you're asking. See the How to Ask page for help clarifying this question.If this question can be reworded to fit the rules in the help center, please edit the question.
Writing documentation for a software product is not easy. When I did it I had to keep in my mind that how the users use the software and I built up the main line of the document. Basically, the documentation followed the user journeys.
But, later we were able to define the different roles who use the software. So to have higher satisfaction I upgraded the documentation which followed the user journeys of the different roles who use the software.
After that I had to learn their language (they were accountant and finance experts) and I used their language in the documentation. Later I asked a few of them to review it before it will be published for all.
Based on this little experience whenever I have to write something I ask the next questions to identify the goals of the documentation: - who will use the software? - how they will use it? - what the main user journeys are? - what the main roles are?
Maybe my answer is trite.
When you prepare the documentation, try to be as specific as possible when describing it. Imagine that you are a potential user that know nothing about the product.