Title

Provide a title for this Work Instruction.

Purpose

State the purpose of this Work Instruction.

Scope

Provide the scope for this Work Instruction.

Prerequisites

Indicates if any pre-requisite(s) prior to carrying out this Work Instruction. Put "Not applicable." if this section is not applicable.

Definitions

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
OAS3Open API Specification Version 3. https://www.openapis.org/


Roles & Responsibilities

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

RoleResponsibilities
CDISC Library API ArchitectDesign and maintain API specification.
CDISC Library Software DeveloperCreate programming code to Implement software.


Instructions

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

Step #RoleInstructions
1.0CDISC Library API ArchitectDesign API specification in OAS3 format in team workspace hosted by Swaggerhub.
1.1CDISC Library API ArchitectInform CDISC Library Software Developer when API specification is ready for implementation.
2.0CDISC Library Software DeveloperImplement API endpoints based on the API specification.
2.1CDISC Library Software DeveloperMake update suggestions where applicable.
3.0CDISC Library Software DeveloperDeploy software code to the development environment.



General Workflow

Include a general workflow diagram that summarizes this Work Instruction.

References

List references pertinent to this Work Instruction, e.g., COP-001.

  • No labels