Changes between Version 29 and Version 30 of Contribute/Documentation


Ignore:
Timestamp:
11/22/12 06:02:34 (9 years ago)
Author:
Michael Howden
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Contribute/Documentation

    v29 v30  
    102102'''Reevaluate  : ''' Validate the final specifications document. [[BR]]
    103103
    104 === [=#docWorkflow]!Write/Update User Guidelines for a workflow ===
    105 Write generic User Guidelines wiki page for a workflow for a Sahana Eden module. The documentation should adhere to the following outline:
     104=== [=#docModule]!Write/Update User Guidelines for a Module ===
     105Write 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:
    106106
    107107''start of outline''
     108{{{
     109== <Title of the Module> User Guidelines ==
     110=== Introduction ===
     111<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 >
     112=== Data Model ===
     113<a list of the tables that the user can access in the module>
    108114
     115=== Reports ===
     116The reports that the user can generate and a brief explanation about them
     117
     118=== Workflows ===
     119<links to workflows for that module>
     120}}}
     121''end of outline''
     122
     123List of Modules to document:
     124
     125* Staff
     126* Volunteers
     127* Assets
     128* Organisations
     129* Requests
     130* Inventory/Warehouse
     131* Projects
     132
     133Ensure that you review and merge any current UserGuidelines.
     134
     135
     136=== [=#docWorkflow]!Write/Update User Guidelines for a Workflow ===
     137Write 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:
     138
     139''start of outline''
     140{{{
    109141== <Title of the workflow> ==
    110142=== Introduction ===
    111143<basic purpose of the workflow>
    112144=== Details ===
    113 <step by step description of the workflow>
     145<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 >
    114146=== Screenshots ===
    115147<thumbnails of each stage, clickable to see full size>
    116148=== Related Workflows ===
    117149<links to related workflows>
    118 
     150}}}
    119151''end of outline''
    120152