Revision Date: 2023.09.29
Table of Contents
I. Description
This procedure describes the processes used by Sage Governance to create new or revised SOPs, Reliable Methods (RMs) or other documents. Stages of the document development process include:
Drafting
Review and Approval
Finalization & Posting Current Versions
Archiving Past Versions
Updating the Document Index
Organization-level Sage Policies will be revised, reviewed, finalized, posted, and archived in PowerDMS. Sage Governance will adhere to the processes for using PowerDMS in developing and maintaining organization-level policies.
II. Scope
This Reliable Method applies only to Sage Governance team members creating and maintaining SOPs, Reliable Methods and other Governance resources.
III. Definitions & Acronyms
N/A
IV. Authorities/Responsibilities
From SG- SOP01:
“The Vice President for Research Governance and Ethics is responsible for approving Policies and delegating members of the Governance team to develop and maintain SOPs. All Governance team members are responsible for writing and maintaining process resources through the course of their daily work and sharing them with an appropriate audience (i.e., internal to Governance, shared broadly with the entire organization, or potentially shared externally through an appropriate medium).”
V. Procedures
A. Drafting SOPs and RMs
Follow this Drafting process when:
A completely new SOP or RM is being created, or,
A revision is being made to an SOP, or,
A revision is being made to a RM and the revision is not a simple/quick update (see V.D.).
If the “Draft” is a simple/quick revision to an existing RM posted in Confluence, see V.D; otherwise, continue to V.A.2
For revisions to an existing SOP or RM, make a copy of the document found in the CURRENT folder using the File/Save a Copy command, and save it in the Google Drive folder:
“DRAFTS – Policies – SOPs – RMs – Resources”
For new or converted SOPs or RMs, use an existing Document template, if applicable. i.e.:
For revisions to an existing SOP or RM:
Document renaming is not required.
If the draft is revising an existing document, track the changes using Suggest mode. Add comments as needed.
Update the date in the filename when the document is updated. To avoid confusion, the revision date in the top of the document itself should remain highlighted as a date placeholder until it is finalized.
Once a Draft is ready for review, proceed with VI.C. for SOPs or VI.D for RMs.
B. Resources Created Outside of Google
Some resources are created in other software mediums such as LucidChart. Whenever possible and feasible:
Resource authors should attempt to incorporate these resources into new or existing SOPs or RMs. For example, include a process diagram or decision chart into a new or existing document.
If resources do not fit well into an existing SOP or RM, resource authors should consider creating another type of freestanding document to house the resource and ensure it is indexed and referenced in Confluence.
The purpose of creating a freestanding document is to help:
Differentiate between drafts and current versions,
Ensure that the resource is used properly and consistently, and to
Maintain a document archive.
C. Review of SOPs
Prior to SOPs being finalized and posted, the SOP should be reviewed by:
A peer who is involved in completing the work (if available).
A member of the Governance Senior Team.
The Vice President for Research Governance and Ethics or designee(s)
To obtain review:
Add a comment to the Draft Google Document,
Tag the person for review,
Include a due date, when possible, to maintain a controlled review timeline,
Repeat the tagging steps with each person involved in the review process,
The Vice President for Research Governance and Ethics should be the final reviewer who indicates the SOP can be finalized. (At this time, “approval” of the final review will be an informal process verified through comments in the Google Document only.)
When review is complete, proceed to VI.E.
D. Review of RMs and Other Process Resources
RMs and other process resources may be subject to frequent “simple/quick” changes in order to facilitate an accurate reflection of the procedures that should be followed on a daily basis.
Review of New Reliable Methods
Consult your manager to determine who should be part of the RM review process and/or who should approve.
To obtain review:
Add a comment to the Draft Google Document,
Tag the person for review,
Include a due date, when possible, to maintain a controlled review timeline,
Repeat the tagging steps with each person involved in the review process. (At this time, “approval” of the final review will be an informal process verified through comments in the Google Document only.)
When review is complete, proceed to VI.E.
Review of Revisions to Reliable Methods: If a member of the Sage Governance Team identifies inaccuracies in a RM or similar process resource, take one of the following two approaches.
If the team member is certain of the accuracy of the update:
Make the update directly into Confluence.
Update the version date.
Create a Final version following V.E.
If the team member is uncertain of the accuracy of the update and needs input:
Add a comment into Confluence to indicate the additional process steps or clarifications that need to be made.
Start a formal Draft following the process in V.A.
E. Finalization & Posting of Current Documents to Confluence
Once all review processes are completed (as applicable).
Current versions of Governance documents should be saved to the Google Drive folder:
“CURRENT – Policies – SOPs – RMs – Resources”
** Up to three documents may represent the “Current” version of a document and these must be clearly labeled:
A Tracked version showing all changes made between the last version and present version. This is done to create an audit trail.
A Clean version in Google Docs format.
A PDF version for ease of sharing.
If a current version of the document exists, move the existing “current” document to the ARCHIVE folder using the process in VI.F.
Add a version date to the document on the top left corner under the title.
Move a copy of the Draft version to the CURRENT folder. Use the following naming scheme for this “tracked” version.
[SG-SOPXX-XX] [DATE in yyyy.mm.dd] [Document Title]
Resolve all tracking/suggestions, comments and highlights, unless any existing comments are there to inform additional conversation for the next draft.
If the document is new:
Create a new Page in Confluence and place the page in the correct indexing hierarchy in the menu on the left of the page.
Copy/Paste the content of the document into Confluence.
Add the document to Document Index Confluence Page.
If the document is not new:
Make the appropriate updates to the existing Confluence Page. Ensure that the version date and document history section is updated.
F. Archiving Past Versions
Archived versions of Governance documents should be saved to the Google Drive folder:
“ARCHIVE – Policies – SOPs – RMs – Resources”
Archived version follow the naming scheme:
[SG-SOPXX-XX] [DATE in yyyy.mm.dd] [Document Title] [ARCHIVE]Prior to finalizing a revised document, ensure an archive version is created in two versions.
When applicable, a PDF version.
A Google Docs version.
Ensure that file naming and file version dating place the documents together when sorted by filename.
G. Updating Superseded or Obsolete Confluence Pages
Whenever possible, existing SOPs, RMs, or other resources in Confluence should not be deleted in order to ensure that any existing links created by other teams do not suddenly break upon the document update. Instead of deleting, Governance should place a clear header on the Confluence indicating the status of the document as Superseded or Obsolete and providing a link to the updated resource. The page can be moved to an appropriate archiving section in the document menu hierarchy on the left of the screen.
VI. Associated Documents and Resources
VII. Revision History
Version #, Date | Description |
V1, 2023.09.29 | New Document |