|
Size: 3147
Comment:
|
← Revision 3 as of 2010-03-17 13:09:08 ⇥
Size: 3156
Comment: converted to 1.6 markup
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 34: | Line 34: |
| * [:TaskD.1.1AnalysisDocument: Analysis Document] * [:TaskD.1.1DesignDocument: Design Document] * [:TaskD.1.1SystemMaintenanceDocument: System Set-up and Maintenance Document] |
* [[TaskD.1.1AnalysisDocument| Analysis Document]] * [[TaskD.1.1DesignDocument| Design Document]] * [[TaskD.1.1SystemMaintenanceDocument| System Set-up and Maintenance Document]] |
| Line 39: | Line 39: |
| * ["TaskD.1"] | * [[TaskD.1]] |
| Line 43: | Line 43: |
| [[PageDicts(Action,Iteration, Time used,Status,Notes,Tasks adressed ~= TaskD.1.1)]] | <<PageDicts(Action,Iteration, Time used,Status,Notes,Tasks adressed ~= TaskD.1.1)>> |
| Line 56: | Line 56: |
| * [:TaskD.1.1ReviewCorrectionList:Corrections] done. We (kfc and bam) should meet to review corrections. | * [[TaskD.1.1ReviewCorrectionList|Corrections]] done. We (kfc and bam) should meet to review corrections. |
| Line 64: | Line 64: |
| * 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. |
* 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. |
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
Parent task
Progress history
| Iteration | Time used | Status | Notes |
2007-10-12
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 Documentation and Wiki Site Guidelines.
We have decided on the Dia program for drawing structured diagrams as our primary diagram editor, and this recommendation is also included on the DOMS Documentation and Wiki Site Guidelines page. See DOMS Documentation and Wiki Site Guidelines for the full guidelines.