Versions Compared

Key

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

...

This work instruction extends from the Document Management Policy and is dependent on a CDISC harmonized system where systems where documentation is created and maintained.

...

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
Stability PeriodThe period from the creation or update of a document when it is considered is accurate and reliable, after which it must be reviewed, confirmed reliable again, updated, or archived.  The stability period is set at the time of creation or update and can be no longer than 2 yearsTime To Live (TTL)This is how long a document is considered to be reliable before it must be reviewed and either confirmed reliable and necessary, updated, or marked for archival.

Roles & Responsibilities

...

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

Step #RoleInstructions
1.0Document Owner

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

  • Create a Name as follows according to the type of document.  Below are some examples:
    • Emails - Internal Emails can just have the title of the subject. External Emails need to have "CDISC" + title
    • SOPs - SOPs will include numbers at the end of the title according to the Standard

    • Work Instructions - Name of the work instruction + "Work Instructions"
    • Policies and guidance - Name of the policy + "Policy" + Version
    • Meeting papers and minutes  - "Data Science" + "Meeting" + date
    • Education material - Name of the topic + Version
    • Reports - Name of the report + "Data Science"
    • Contracts  - Name of the employee or contractor + "Contract" + "Confidential"
    • Presentations  - Name of the presentation + "Data Science"
      • e.g.
Data
      • 2021-08-04 Data Science Meeting
08-04-2021
  • Identify a Category by adding: 
    • Class A - This kind of
documents
    • document will be kept without any
modifications and for as long as the department exists as these kinds of documents do not need an update for the reason that they were just created to resume
    • modification since it was created for an event in the past. Examples of these documents are meeting papers and minutes.
    • Class B - This kind of informational document will
be revised every year and the owner will
    • have a Stability Period.  When the stability period is exhausted, the document will need to be reviewed by the owner to decide if the document is reliable or if it needs an update
or it is not needed anymore
      • e.g. 
Data
      • 2021-08-04 Data Science Meeting
08-04-2021
      • . Class A
  • Establish Confidentiality by adding any of the following at the end of the name:
    • Public - Available to be viewed by anybody in the world.  All documents should have a designation but any document without a designation will be considered Public.
    • Members - Available to be viewed by CDISC membership.
    • Internal - Available to be viewed by anybody within CDISC (employees and contractors). 
    • Confidential - Available to only a restricted group of CDISC employees and/or contractors. 
    • Classified - Available to only a restricted group of CDISC employees.  The Department head has to approve sharing with anyone else.   
      • e.g. 
Data
      • 2021-08-04 Data Science Meeting
08-04-2021
      • . Class A. Internal
  • 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

Store the document in the appropriate CDISC system used by the Data Science

Team (Confluence Wiki, SharePoint / OneDrive, Azure DevOps Wiki, GitHub Wiki)

Team  

/OneDrive when
  •  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

documents only through the approved CDISC systems

- Outlook and SharePoint/OneDrive (if it's too large for email)
  • Distribute documentation via MSFT Outlook Email
  • .  

    With prior Department Head approval, when appropriate an external system may be used to distribute/post.

    Distribute documentation that is too large for email by placing it in Sharepoint/OneDrive

    4.0Document Owner

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

    • Review the document at the end of the stability period and determine if it is still relevant
    • Update the document if it is still needed by the department but needs additional or updated information and reset its stability period
    • Archive the document if it is not needed by the department 
    5.0Department Head

    Send to Document Owner

    to update and/or

    confirm document reliability, or to update and add

    one year

    time to the end of a document's Stability Period, or mark for archival.

  • 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
  • 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.

    ...