Software Release Procedure
From IHRIS Wiki
Below is the ideal iHRIS release procedure. It includes updating User's Manuals (we have not done this in several releases, but should every release) and updating Use Cases (we have not updated these in years, but they need to be updated). It also includes all pages and links that must be updated, as well as announcements that need to be posted whenever a new version of any of the iHRIS software products is released.
NOTE: All electronic Toolkit updates will also need to include an additional update to the Toolkit ZIP file, which is used for burning on software and flash drives. The latest ZIP is always located here: http://www.capacityproject.org/hris/hris-toolkit/hris-toolkit.zip NEED TO UPDATE ZIP FILE!
- 1 User's Manuals (Help)
- 2 Bug Reports and Features Lists (responsibility of Carl/Luke)
- 3 Use Cases (Carl/Luke to update this procedure)
- 4 Draft Announcement (Carl/Luke to send notification and information to Brooke/coordinate with Comms)
- 5 Release Notes (Responsibility of Brooke)
- 6 Website Software Pages, Features Lists, and Roadmaps (Responsibility of Brooke)
- 7 Download Links (Brooke's responsibility, Carl/Luke to provide links)
- 8 Announcements (Responsibility of Brooke, coordinate with Comms if needed)
User's Manuals (Help)
During testing, update the Help File Originals with any procedures that have changed and new features. Update screenshots of changed screens as well. NOTE:
Create a book for each user's manual on the wiki. The iHRIS Manage User's Manual and iHRIS Qualify User's Manual has already been created, but will need to be updated if any pages are removed or added. NOTE: A book for iHRIS Plan will need to be generated.
Generate a new HTML version of the user's manual to include with the software (Luke). Generate a PDF to include in the electronic Toolkit. Upload the PDFs to this location: http://www.capacityproject.org/hris/hris-toolkit/tools/pdf/. See the Software Documentation page for individual filenames (all website links point here). Also add copies to the electronic Toolkit ZIP file.
NOTE: If there have been any changes to the Data Dictionary, you will also need to generate that file as a PDF and upload to the electronic Toolkit in the same locations as the user's manuals.
Bug Reports and Features Lists (responsibility of Carl/Luke)
Use Cases (Carl/Luke to update this procedure)
Update all use cases with changes, resolved issues or new issues. Write new use cases or requirements, if needed to document new features. The original use case files are located on SharePoint in the iHRIS Software Suite Document Library. You will need CaseComplete to update the files.
NOTE: There are 4 use case files: one for each of the software programs, and one for use cases that are common to all of the programs in the suite. If you open multiple use case files in CaseComplete, you can print them to the same report.
If there have been changes, generate a new HTML report for each software program: Manage, Qualify and Plan. Be sure to include the shared (Common) use cases in each of these reports. Upload these to the website at this location: http://www.capacityproject.org/hris/suite/. See each software page for individual filenames.
Also generate a new Word report separately for each software program: Common, Manage, Qualify and Plan. I generally edit the Word reports to remove use cases that have not yet been implemented and open issues, so as to prevent confusion. Upload the DOCs to this location: http://www.capacityproject.org/hris/hris-toolkit/tools/doc/. See the Software Documentation page for individual filenames. Also add copies to the electronic Toolkit ZIP file.
Draft Announcement (Carl/Luke to send notification and information to Brooke/coordinate with Comms)
Draft announcements for two audiences:
- Implementers (via iHRISdevelopers and iHRISannounce lists)
- Wider Stakeholders (to be posted on blog and used as news briefs)
Include the new version #, summary of any new features, summary of bug fixes, list of language options, link to the development timeline for a full list of changes, links to downloads, and a link to the README files.
Release Notes (Responsibility of Brooke)
Update the README files with the latest version number, release date, new features/bug fixes in the release and known issues with the release.
Save each new release file as a README file in TXT format. Upload the README file to the download pages on Launchpad for each release.
Responsibility of Brooke
Website Software Pages, Features Lists, and Roadmaps (Responsibility of Brooke)
For each software release, update the specific software page and the related features lists and roadmaps on the website. The software page should be updated with the latest version number. The features list should be updated with the latest version number, all features available in the latest version, all planned features scheduled for development, and all requested features not yet scheduled. The roadmaps should be updated with the date and location of the latest release and the timeline for planned releases.
- iHRIS Qualify iHRIS Qualify page, Features, and Roadmap
- iHRIS Manage iHRIS Manage page, Features, and Roadmap
- iHRIS Plan iHRIS Plan page,Features, and Roadmap
Change the link on the Toolkit iHRIS Software Suite page to reflect the change in version number.
Announcements (Responsibility of Brooke, coordinate with Comms if needed)
Announce the new release version.
Send the Implementers Announcement to:
Post/send the Wider Audience announcement to:
In addition, disseminate further by:
- Repurposing blog entry as a news article on CapacityPlus site/IntraHealth site
- Tweeting new release info via iHRIS Twitter account (encourage retweets by CapacityPlus, IntraHealth, IntraHealth Open, etc.)