Release Process - Branch and Merge
Major updates and new pages should be done using the SWEHBDOC Branch and Merge Process. This will keep the new content away from the general population of Handbook users during the development process and give reviewers access to see and make comments before the content is released. The process below may be used during the review period and certainly at the time of the general release of the content to the general area of the Handbook.
- Review each watch email to identify changes.
- Use the checklist in tab 1 of SWEHBDOC Content Style and Consistency to identify changes that need to be corrected.
- For each change requiring correction, edit the page and make the necessary correction.
- Save and review the page to ensure that all corrections were made properly. Fix any problems found.
- Discard watch emails once they have been reviewed and corrections are verified.
- Major updates or new pages should have a blog post prepared and published announcing the release of the update or new page. See SWEHBDOC Blogs In SWEHB for details on building and publishing Blog posts in SWEHB.
Creating New Pages or Updating Pages - Checklist
When preparing either a New Page of just updating an existing page. The "Checklist for New SWEHB Page" should be copied and used to track all the actions necessary for the page. Using this checklist will help ensure that all the steps for the page are completed and nothing is missed.
The "Checklist for SWEHB Page" should be stored under the page that it is used for. Example: be for the new Topic page "8.28 - Preparing and Evaluating Commercial Services Contracts" the checklist would be under it in the hierarchy and named: "Checklist for 8.28". The checklist would be used and updated to track the steps to create the new 8.28 page. Once the page is published and the blog posted, the checklist remains under the parent until a significant update is made to the page. When an update is necessary, a new update checklist is created to replace the new page checklist.
