The possible pathways for revision requests:
To support a new release (edits passed along from Testing, Tech Docs, or other group, usually facilitated by the Community Engagement Coordinator)
Community requests (via user manual comment, via request received through Community Engagement Coordinator, feedback from querying users, etc.)
Efforts by the User Documentation Sub-Team to keep manual up-to-date (reviews of pages undertaken by team)
For each of the pathways by which a revision request might arrive, the following steps will be taken:
Team member is assigned a page to edit
Community requests received via manual comment should be addressed by the primary page watcher.
At the start of each term, each team member will be assigned pages which they will serve as primary and secondary watchers for.
Team members should watch pages they are responsible for using the Confluence watch feature. Once they are watching a page, they will be notified of any community comments on the pages.
When extensive revision is needed to several pages, work may be assigned among all team members
Team member makes changes but does not publish
If changes are made due to a change in function in a new version release, the existing page should be versioned before editing
Changes that have been made to a page should be made in red so it’s easy for the reviewer to see what has been changed without looking at revision histories
If you are deleting text, use the strikethrough feature rather than deleting the text
Refer to style guide for guidance on page creation and maintenance.
Team member notifies secondary watcher that edits have been made and asks them to proofread the page
Secondary watchers should be notified using the “Invite to Edit” feature in Confluence. Inviting someone to edit a page will send them an email that will include a link to the page and any message included in the invite. Primary watchers may want to invite themselves so they can refer back to their invite.
Secondary watcher reviews the page and provides feedback
Team member changes any red test to black, then publishes page