Action System Documentation

Assigned

JRG

Prev assigned

Tasks adressed

["TaskX/1"]

Time estimated

not done

Time used

0md

Priority

4

Status

Not described

Iteration

13

Notes

The system documentation should contain:

• White Paper (medium priority)
  • A "product specification", not for developers or end-users, illustrating high-level architecture - an overview of capabilities for non-technical people.
• Data Model Language documentation - per link to already written wiki-pages (medium priority)
• Documentation of APIs (high priority)
  • PID generator webservice (including WSDL)
  • File Characterization webservice (including WSDL)
  • Search webservice (including WSDL)
  • Bitstorage webservice (including WSDL)
  • Fedora API-M/A (?)
  • LDAP API (?)
• Design Documentation (low priority)
  • Fedora setup and use
  • Summa integration (digital object bundle, OAI, playback disseminators)
  • GUI developer documentation
  • Validation tool documentation

Checklist For Working On An Action

The Life Cycle of an Action:

• Assign people for action definition: Done at start of iteration status meeting. Fill out Assigned

• Define the action: Describe information about what is to be done and how. Fill out Tasks Addressed and Time Estimated.

• Review the definition: Get another project group member to review the action definition, and update it.

• Assign people for action implementation: Done by project manager, usually the same persons who wrote the definition. Fill out Assigned and Prev assigned if new persons are assigned.

• Implement the action: See details below

• Review the action: Get another project group member to review what is implemented (code and documentation), and update it.

• Finish the action: Change the status to "Finished" and update the "time used" field on the action page.

Please make sure that you address the below issues, when working on an action:

• Update the state of the action to "In Progress" when you start working on it.
• Check if the tasks addressed by this action have their status set to "In Progress". If that is not the case, then change the state of them.

• Keep track of how much time that has been spent working on the action. If it addresses more than one task, then make a note on the action page about how much of the elapsed time that has been spent on the individual tasks. Hint: Continually updating the "Time used" field will make it easier for you.

• Update the "Progress History" and documentation pages of each task addressed by this action when appropriate. This depends on the situation, but in general, the task pages should hold all important related information about the work done, experiences gathered, identified requirements and so on.