Action Update Datamodel Documentation

Assigned

ABR+JRG+KFC

Prev assigned

Tasks adressed

TaskA.2

Time estimated

5md

Time used

2md

Priority

5

Status

In progress

Iteration

13

Notes

The Problem

The DOMS datamodel is almost finished, but the documentation if sorely lacking. The documentation for the datamodel must be brought up2date, and finalized in a structure that allows it to be presented to people outside the team.

To be more precise, the following documents must be updated or made

• DataModel - Detailing the DOMS base collection

• FedoraOntology - Detailing the Ontology lanquage

• FedoraTypeChecking - Detailing the extensions to the DS-COMPOSITE stream

• FedoraViewBlobs - Detailing the View system, which allows you to view many objects as one

• FedoraObjectTemplates - Detailing the prototype system for content models

• DomsCollections - Detailing the use of collection objects in DOMS

• FedoraLicensePolicies - Detailing the License system, and how it interacts with the Search system

• FedoraTransactionsReplacement - Detailing the use of the STATE datastream to allow for some transaction-like processes

• DomsNameSpacesAndSchemas - List the namespaces used, to avoid duplication and misuse

• DomsAuditTrail - Detailing how DOMS logs changes and new versions

• DomsFileHandling - Detailing how we expect to handle file objects in Fedora.

The finished documentation must be review by Mjoelner, before this action is complete.

Progress

• DataModel -

• FedoraOntology - DONE, 1h (not reviewed)

• FedoraTypeChecking -

• FedoraViewBlobs - DONE (5h) to KFC

• FedoraObjectTemplates - DONE, 2h, to KFC

• DomsCollections - DONE, 2h

• FedoraLicensePolicies - DONE, 1h

• FedoraTransactionsReplacement - DONE, 2h, to KFC

• DomsNameSpacesAndSchemas - DONE, 1h

• DomsAuditTrail - DONE, 1h

• DomsFileHandling - DONE, 2h, not reviewed

Conclusion

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.