Differences between revisions 1 and 2
Revision 1 as of 2008-06-26 12:26:14
Size: 2547
Editor: kfc
Comment: Created by the PackagePages action.
Revision 2 as of 2008-08-20 07:56:30
Size: 2632
Editor: abr
Comment:
Deletions are marked like this. Additions are marked like this.
Line 50: Line 50:
[[PageDicts(Action,Iteration, Time used,Status,Notes,Tasks adressed ~= TaskD.1)]]

D.1. Make Documentation Guidelines

State: Not started

Time used: 0 md.

Description

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

Parent task

  • ["TaskD"]

Progress history

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

TaskD.1 (last edited 2010-03-17 13:09:04 by localhost)