Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Purpose

Ensure This work instruction ensures that documents are being managed and maintained appropriately. This work instruction It sets out the steps to enable the Data Science Team to create, maintain, distribute, maintain, and when necessary, deleted archive documents.

Scope

The scope of this work instruction is focused solely on documentation that Data Science uses needs to retain for information purposes and intentionally omits letters, emails, etc. 

...

List terms (abbreviations, acronyms, technical jargon) referenced in this Work Instruction useful at adding clarity. Put "Not applicable." if this section is not applicable.

TermDefinition
Time To Live (TTL)This is how long a document is considered to be valid before it must be reviewed and either confirmed reliable and necessary, updated, or marked for archival.


Roles & Responsibilities

Lists all roles and their responsibilities relevant to this Work Instruction.

RoleResponsibilities

Document Owner

Creates, updates, archives documents based on their usefulness or sends them to legal hold.

VP Data ScienceDepartment Head

Responsible for document owner fulfilling responsibilities and assigns replacement document owners as appropriate.

System AdministratorResponsible for systems where documentation is created, maintained, and managed. 

...

Describe each step to be taken to complete the scope of this Work Instruction in the prescribed sequence. Use active verb verbs in the Instructions column.

Step #RoleInstructions
1.0Document Owner
Creates

Create a document

using the

and title it with a name, category, and confidentiality classification.

  • Create a Name by...
    • e.g.
  • Identify a Category by...
    • e.g.
  • Establish the Confidentiality by...
    • e.g.
  • Documents that are created have a default stability period from the date of creation that specifies the minimum time the document is expected to be accurate and reliable.
2.0Document Owner
Distributes or Stores

Store the document

through

in the appropriate CDISC system used by the Data Science Team (Confluence Wiki, SharePoint / OneDrive, Azure DevOps Wiki, GitHub Wiki)

2.1

SharePoint
  • Store documents in SharePoint/OneDrive when they are Policies and Standard Operation Procedures.
  • Store documents in Confluence Wiki when they are used to collaborate and share information with CDISC and CDISC Members.
  • Stoe documents in Azure DevOps Project Wiki that are used for the project and technical artifacts and maybe a draft of published content to GitHub Wiki.
  • Store documents in the GitHub Wiki that are pertinent to Open Source projects' technical artifacts.
3.0Document Owner

Distribute document only through the approved CDISC systems - Outlook and SharePoint/OneDrive (if it's too large for email)

4
2.2Confluence Wiki2.3Azure DevOps Project Wiki2.4GitHub Wiki2.53
.0Document Owner
Maintains

Maintain the document to make sure that the content is accurate and

available3.1Document OwnerReviews the document after one year of its creation

reliable

  • Review the document at the end of the stability period and determine if it is still relevant
  • Update
3.2Document OwnerUpdates
  • the document if it is still needed
for
  • by the department but needs
added information3.3Document OwnerSends the document to Archived Period if
  • additional or updated information and reset its stability period
  • Archive the document if it is not needed
for the department after the one year review
  • by the department 
5
4
.0
VP Data ScienceDecides if it is time to delete the document from Archived Period or give a one-year extension
Department Head

Send to Document Owner to update and/or confirm document reliability and add one year to the end of a document's Stability Period or mark for archival.

4.1VP Data Science

  • Reestablishes the document to its previous location and owner after two years in Archived Period if he considers that the document could be used again
4.2VP Data Science
  • Deletes the document after two years in Archived Period if is not needed anymore
6.0Department Head

Provide a valid document owner when a document owner leaves the department or company 


General Workflow

Include a general workflow diagram that summarizes this Work Instruction.

...