##Task
## If any of the below links or sections are not applicable to your page, then please comment them out rather than deleting
## as they may become relevant later on.

= D.1.1. Guidelines for Design Documentation =

## Valid states: "Not started", "In progress" and "Finished"
'''State:''' Finished

## The time used is measured in man days and does not include the time spent on any sub-tasks.
'''Time used:''' ??? + review 3/2 md.

== Description ==

## Add a high level task (goals / sub-goals) description here, sufficiently detailed to provide a background for creation of action descriptions.
## Any available (technical) details goes into the below documentation pages.

Write guidelines for analysis and design documents. Decide if the documentation should be written in the wiki. Decide on a program for drawing diagrams.

##== Sub tasks ==
## . [:TaskX.Y.Z: Add sub task link 1 here]
## . [:TaskX.Y.Z: Add sub task link 2 here]
## .         ..[[BR]]
## .         ..[[BR]]
## .         ..
## . [:TaskX.Y.Z: Add sub task link N here]

== Documentation ==
## The documentation section links to the documentation relevant to this task and its sub-tasks (if any).
##
## The below links will automatically be expanded to page names like "MyTaskPageNameAnalysisDocument" in your created page.
## This should be a proper default, however, it may be changed.
##
 * [[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 ==

<<PageDicts(Action,Iteration, Time used,Status,Notes,Tasks adressed ~= TaskD.1.1)>>

## Add information about about the current state of the task here. That is, information about what has been completed so far and
## what outstanding issues that are left. Example:
##
##=== 2007-09-13 ===
##Finished the design documentation. A review is needed before this task can is completed.
##
##=== 2007-08-25 ===
##Completed requirement specification. We are now ready for writing the design document.

=== 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.