HughP / simal

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

Create developer documentation section of website #326

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
Developer documentation is aimed at those people wishing to work with the 
source code of the project. They may be motivated by the need to work with the 
latest and greatest code, or they may be motivated by the need to add features 
or fix bugs. Developers are also users, so they will be interested in user docs 
as well as developer docs.

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

    * A description of the software architecture
    * Details of the development process
    * A record of known issues and opportunities for contribution
    * Documentation of the build process, testing procedures and coding standards
    * How to retrieve the source code
    * Details of developer support mechanisms
    * Contributor instructions, i.e. how to create and submit a patch
    * Release process
    * Governance Model
    * Coding standards 

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

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/DeveloperTOC)

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:41

GoogleCodeExporter commented 9 years ago
All done except

    * A record of known issues and opportunities for contribution

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

GoogleCodeExporter commented 9 years ago
Turns out that 

    * A record of known issues and opportunities for contribution

is intended to simply refer to the issue tracker, so closing this one.

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