## page was renamed from D.1. Make documentation guidelines for...
##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. Make Documentation Guidelines =

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

## The time used is measured in man days and does not include the time spent on any sub-tasks.
'''Time used:''' 0 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.

The goal of this task is to write documentation guidelines and documentation templates for the documentation in the DOMS project. The guidelines should standardise the DOMS documentation (to some extent) and ease documentation writing.

== Sub tasks ==

 . [[TaskD.1.1|D.1.1. Guidelines for Design Documentation]]. 
 . [[TaskD.1.2|D.1.2. Guidelines for Javadoc]].
 . /!\ D.1.3. Guidelines for guide for introducing new collections / material into DOMS.
 . /!\ D.1.4. Guidelines for system maintenance documentation.
 . /!\ D.1.5. Guidelines for user documentation for librarians.
 . /!\ D.1.6. Guidelines for user documentation for library users.
 . [[TaskD.1.7|D.1.7. Guidelines for External Documentation]].
 . [[TaskD.1.8|D.1.8. Wiki guidelines]]

/!\ = Deprecated sub-task (replaced by D.1.7).

##== 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.1AnalysisDocument: Analysis Document]
## * [:TaskD.1DesignDocument: Design Document]
## * [:TaskD.1SystemMaintenanceDocument: System Set-up and Maintenance Document]

== Parent task ==
 * [[TaskD]]

== Progress history ==

<<PageDicts(Action,Iteration, Time used,Status,Notes,Tasks adressed ~= TaskD.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.