search

HughP / simal

Automatically exported from code.google.com/p/simal
0 stars 0 forks source link

Create user documentation on wiki #325

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago 
User documentation  is aimed at those people wishing to either use the software 
in a production environment or wishing to quickly evaluate the software before 
using in a production environment or becoming a developer on the project.

The kinds of documentation we would expect to find in this section are:

    * Details of user support mechanisms
    * How to report bugs
    * How to make feature requests
    * Install instructions, including a description of any pre-requisites
    * Getting started instructions
    * Detailed user documentation

Original issue reported on code.google.com by ross.gardler on 20 Jul 2010 at 2:42

GoogleCodeExporter commented 9 years ago 
This is underway, but we need to fulfill all the areas of the user 
documentation as described above.

I've categorised the content on the wiki, see 
http://code.google.com/p/simal/wiki/UserTOC)

We now need to migrate content from the old docs website - 
http://simal.oss-watch.ac.uk/

Original comment by ross.gardler on 20 Jul 2010 at 3:40

GoogleCodeExporter commented 9 years ago 
Updated wiki documentation and moved relevant pages over from old docs website. 
Merged DeveloperTOC and UserTOC since there's not enough documentation to 
confuse people whereas some docs are useful to both groups.

Move this one to fixed although 'Detailed user documentation' is not realised. 
Won't create a new issue for it as it's too generic.

Original comment by sander.v...@oucs.ox.ac.uk on 15 Dec 2010 at 2:51