D.1.1. Guidelines for Design Documentation
State: Finished
Time used: ??? + review 3/2 md.
Description
Write guidelines for analysis and design documents. Decide if the documentation should be written in the wiki. Decide on a program for drawing diagrams.
Documentation
- [:TaskD.1.1AnalysisDocument: Analysis Document]
- [:TaskD.1.1DesignDocument: Design Document]
- [:TaskD.1.1SystemMaintenanceDocument: System Set-up and Maintenance Document]
Parent task
- ["TaskD.1"]
Progress history
2007-10-12
- [:TaskD.1.1ReviewCorrectionList:Corrections] done. We (kfc and bam) should meet to review corrections.
2007-10-09
- Reviewed by kfc and bam. There are a number of trivial correction, and we need guidelines for the project management pages. Follow-up: bam.
2007-09-13
We have decided to try to write all documentation in the wiki. Guidelines for analysis and design documents are written as templates: AnalysisDocumentationTemplate and DesignDocumentationTemplate, and they are also summarised in the [:DOMS_Wiki_Site_Guidelines: DOMS Documentation and Wiki Site Guidelines].
We have decided on the [http://live.gnome.org/Dia Dia] program for drawing structured diagrams as our primary diagram editor, and this recommendation is also included on the [:DOMS_Wiki_Site_Guidelines: DOMS Documentation and Wiki Site Guidelines] page. See [:DOMS_Wiki_Site_Guidelines: DOMS Documentation and Wiki Site Guidelines] for the full guidelines.