This document describes the process of issue and feature tracking and managing their scheduling into new releases of Reveal. This tracking will take place in Jira, through Atlassian platform that integrates with Confluence, where project scoping, note-taking, and general documentation is stored.
Access to this platform will be initially given to those in the Reveal Consortium and its partners, VitalWave and CHAI. As implementations develop, program managers responsible for the technical aspects of the Reveal tool will also have access. We do not envision, at this point, that all users of the Reveal tool would have access, but rather the third and highest tier of the help desk who may be users or administrators.
Management of the platform and the roadmap will be co-owned by the Akros Product Manager and the Ona Development Manager. New issues and their priorities added to issues will be reviewed on routine implementation planning calls. These will be reviewed at high level on routine Reveal Consortium Calls. Akros and Ona will work to evaluate level of effort and schedule the features and bugs accordingly and plan future releases/versions.
Issue Types
There are various issue types enabled in the Reveal Jira configuration. The configuration of the different types is defined here:
Epic (User Story of Feature): Epics will be used to track user stories or features, which will often represent a collection of development tasks. Epics will be entered by implementation users, the product manager, or the development manager. The development manager will work to split Epics into individual development tasks. Other issue types can be linked to Epics if they must be addressed to complete the work for that particular epic.
Bug: Bugs will be entered against current Reveal versions by any user who discovers said bugs.
Form Change: Form changes will often be country specific requests to modify the forms that are attached to tasks in Reveal.
Question: The question field may be used by developers or implementers to resolve a question related to scoping or intended functionality.
Task: Tasks will represent individual development tasks. Translation and string changes should be captured as tasks.
Adding an Issue
- Press 'C' and enter details for the issue. Note the required fields differ slightly depending on which type of issue is selected.
- Fields include:
- Epic Name used to name the feature or user story.
- Summary to include all keywords for searching and should be as short and succinct as possible.
- Platform field used to capture which Reveal platforms are most relevant for this issue.
- Device/Hardware entered if a bug or issue is experienced on a particular hardware type.
- Operating System entered if a bug or issue is experienced on a particular OS.
- Priority as perceived at the time of entering the issue
- Extra detail to go in the Description field. Screenshots can be pasted here or uploaded as attachments (former preferred).
- Affects version to capture the release version that this bug or issue is related to.
- Implementation/Location captures which locations or implementations this issue or bug is relevant to. This is a label field, meaning the user can create different values on-the-fly.
Triaging Issues
The issue workflow will move issues through set of statuses which can be visualized on the Kanban board.
- Any user should be able to add a bug or feature to ‘New’. Akros Product Manager monitors ‘New’, ensures that issues are not duplicates, cleans up Summary and Description, and ensures all necessary info is included (e.g. steps to reproduce, task type, software version, OS, browser version etc). Discusses priority with CHAI and VW and modifies as necessary.
- Move to ‘Triage’
- Move to 'Won't Fix' if the issue is not relevant.
- Ona Development Manager monitors ‘Triage’ and ensures that issues are ready for dev.
- Moves to 'Ready for Dev'
- Ona Development Manager and developers monitor ‘Ready for Dev’ and schedules.
- Moves to 'In Progress'
- Developers handle ‘In Progress’
- Move to 'In Review' when dev complete and version with the fix or feature is released.
- Akros to monitor 'In Review,' and move to 'Done' when testing passes, or back to ‘Triage’ (with a red ‘Reopened’ label) if necessary.
Releases
- Releases will be tracked through Jira release versions.
- Users can track issue progress against versions.
