WP3. Deliverable 3.1 submitted
May 4th, 2011 by Evelyn Torras
This deliverable aims to give a set of content guidelines and define requirements and procedures, for the creation of the user documentation also known as user’s manual. The user manual documentation will support the user’s communities and serve as basis for training documentation. Moreover, it aims to boost participation and interest in the project. This deliverable also serves as technical documentation for understanding the mechanisms and services usage within the Mantychore toolset. Additionally, it will also be used as an indicator of the current state of the project to the external and internal members of the community. This is because the user manual will be updated as long as new software releases of the Mantychore toolset are deployed
Go to Deliverables section to download the full text
Executive summary
The user’s manual documentation is the main channel of interaction with the user community. This document provides a direct support channel to the users, and serves as basis for training purposes and boost participation and interest in the project. Moreover, this deliverable also provides technical documentation for better understanding the Mantychore toolset usage. In fact, it can also be used as a validation point to show the current state of the toolset software releases to the external members of the community and to Mantychore adopters.
In that sense, this deliverable provides the guidelines, requirements and procedures for the creation of the user manuals documentation. These procedures are needed because new versions of the user’s manual, as many software releases we have, will be presented. Thus, it is important that its goals and requirements are clearly defined from the very beginning.
The user’s manual is presented as an appendix A, which will be updated along the project and after each software release. Although the main usage of the manual is through the wiki, as an online Mantychore service, we also provide it as a text document that we will successively update.
To make it extensible to the whole community, this documentation will also be available from the Mantychore’s project web site and from the open wiki.
Posted in Deliverables | Comments Off