Action System Documentation
- Assigned
- JRG+ABR
- Prev assigned
- BAM
- Tasks adressed
- Time estimated
- 5md
- Time used
- 4md
- Priority
- 4
- Status
- In progress
- Iteration
- 13
- Notes
- Depends on "Action WSDL2 Java"
The system documentation should contain:
Documentation of APIs (high priority)
- PID generator webservice (including WSDL from "Action WSDL2 Java")
- File Characterization webservice (including WSDL from "Action WSDL2 Java")
- Search webservice (including WSDL from "Action WSDL2 Java")
- Bitstorage webservice (including WSDL from "Action WSDL2 Java")
- Fedora API-M (Including Fedora documentation as well as in what ways Fedora should be used. Include API-A and Risearch.)
- Import/export APIs (handled in "Action Import/Export APIs")
The documentation should be delivered to and reviewed by Mjølner.
Time estimates:
- Documentation of APIs (4 md)
- Corrections based on feedback from Mjølner (1 md)
Total: 5 md (there will most likely be a deadline for this)
The following have been punted:
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.
- Documentation of:
- 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.