Changes between Version 29 and Version 30 of Contribute/Documentation

Timestamp:

11/22/12 06:02:34 (12 years ago)

Author:

Michael Howden

Comment:

--

Contribute/Documentation

@@ -102 +102 @@
 '''Reevaluate  : ''' Validate the final specifications document. [[BR]]
 
-=== [=#docWorkflow]!Write/Update User Guidelines for a workflow ===
-Write generic User Guidelines wiki page for a workflow for a Sahana Eden module. The documentation should adhere to the following outline:
+=== [=#docModule]!Write/Update User Guidelines for a Module ===
+Write generic User Guidelines wiki page for a Sahana Eden module. The page should be located at {{{UserGuidelines/<Module>/<Workflow>}}}. The documentation should adhere to the following outline:
 
 ''start of outline''
+{{{
+== <Title of the Module> User Guidelines ==
+=== Introduction ===
+<Description of the module. Where possible include some sort of flow chart or diagram. This should be designed using Google Draw and embedded in the wiki page. Include the link to the Google Draw file so that others can edit it >
+=== Data Model ===
+<a list of the tables that the user can access in the module>
 
+=== Reports ===
+The reports that the user can generate and a brief explanation about them
+
+=== Workflows ===
+<links to workflows for that module>
+}}}
+''end of outline''
+
+List of Modules to document:
+
+* Staff
+* Volunteers
+* Assets
+* Organisations
+* Requests
+* Inventory/Warehouse
+* Projects
+
+Ensure that you review and merge any current UserGuidelines.
+
+
+=== [=#docWorkflow]!Write/Update User Guidelines for a Workflow ===
+Write generic User Guidelines wiki page for a workflow for a Sahana Eden module. The page should be located at {{{UserGuidelines/<Module>/<Workflow>}}}. The documentation should adhere to the following outline:
+
+''start of outline''
+{{{
 == <Title of the workflow> ==
 === Introduction ===
 <basic purpose of the workflow>
 === Details ===
-<step by step description of the workflow>
+<step by step description of the workflow. Where possible include some sort of flow chart or diagram. This should be designed using Google Draw and embedded in the wiki page. Include the link to the Google Draw file so that others can edit it >
 === Screenshots ===
 <thumbnails of each stage, clickable to see full size>
 === Related Workflows ===
 <links to related workflows>
-
+}}}
 ''end of outline''