D. Documentation

State: In progress

Time used: 0 md.

Description

The DOMS project is expected to produce documentation in the below categories:

• Documentation for developer use, such as coding guidelines, guidelines for how to use the development environment.
• Documentation for the system managers that will be managing and operating the DOMS in the production environment.
• Documentation/Guidelines for installation of the DOMS, any software components that it depends on, and instructions for a proper configuration of the run-time environment.

For each of these documentation categories there must also be produced guidelines for layout and contents to ensure that documents produced by different authors are uniform.

Sub tasks

• [:TaskD.1:D.1. Make documentation guidelines]
• [:TaskD.2:D.2. Write developer guidelines]
• [:TaskD.3:D.3. Identify workflows requiring documentation, and generate it.]
• [:TaskD.4:D.4. Create overall system documentation.]
• [:TaskD.5:D.5. Create preservation strategy documentation.]
• [:TaskD.6:D.6. Create API/Interface documentation.]
• [:TaskD.7:D.7. Design documentation]

Parent task

• ["WBS"]

Progress history

PageDicts(Action,Iteration, Time used,Status,Notes,Tasks adressed ~= TaskD)

2008-06-03

Updated this group with results of Doms Day Discussions. Each leaf-task now contains a list of expected documents.

2008-04-21

Made a round-up of what parts of this task have been made so far and by whom. See details [:RoundUpTaskD2008-04-21:here].