## page was renamed from D. Documentation ##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. Documentation = ## Valid states: "Not started", "In progress" and "Finished" '''State:''' In progress ## 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 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]] ##== 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. ## * [:TaskDAnalysisDocument: Analysis Document] ## * [:TaskDDesignDocument: Design Document] ## * [:TaskDSystemMaintenanceDocument: System Set-up and Maintenance Document] == Parent task == * [[WBS]] == Progress history == <> ## 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. === 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]].