Action High Level Design Documentation
- Assigned
- KFC(1md), PKO(2md), JRG(3md)
- Prev assigned
- Tasks adressed
- ["Tasks/7/4"]
- Time estimated
- 6md
- Time used
- 1md (JRG)
- Priority
- 5
- Status
- Not started
- Iteration
- 21
- Notes
High level design documentation for the final DOMS, that is the DOMS created by Milestone 7. Includes documentation written in ["Tasks/3"], and possibly more. May include graphics.
Draft of table of contents:
- Overview of a DOMS system
- System structure
- DOMS objects
- Datamodels
- Usage of a Fedora repository (separate project)
- Usage of the Fedora ECM (seperate package)
- Validation
- Interfacing with a bitstorage (separate package)
- Handling OAI-PMH requests (separate package)
- Interfacing to search engines (seperate packages)
- Usage of the DOMS GUI (separate package)
- The included testbed
The documentation itself (output of this action) can be found [:HighLevelDesignDocumentation:here].
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.