Title
Software Development.
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.
| Term | Definition |
|---|---|
| OAS3 | Open API Specification Version 3. https://www.openapis.org/ |
Roles & Responsibilities
Lists all roles and their responsibilities relevant to this Work Instruction.
| Role | Responsibilities |
|---|---|
| CDISC Library API Architect | Design and maintain API specification. |
| CDISC Library Software Developer | Create 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 # | Role | Instructions | Notes |
|---|---|---|---|
| 1.0 | CDISC Library API Architect | Design API specification in OAS3 format in team workspace hosted by Swaggerhub. | |
| 1.1 | CDISC Library API Architect | Inform CDISC Library Software Developer when API specification is ready for implementation. | |
| 2.0 | CDISC Library Software Developer | Implement API endpoints based on the API specification. | |
| 2.1 | CDISC Library Software Developer | Make update suggestions where applicable. | |
| 3.0 | CDISC Library Software Developer | Deploy software code to the development environment. | |
| 1.0 | Makes a software request. | ||
| 1.1 | CDISC Portfolio Owner | Approves new software project. | |
| 1.2 | Product Owner | Approves new features, enhancements, and/or bug fixes. | |
| 3.0 | SCRUM Master | Adds details to the SCRUM backlog. | |
| 3.1 | SCRUM Master | Grooms related work items to sprint. | |
| 4.0 | Software Developer | Begins programming tasks. | |
| 4.1 | Software Developer | Maintains CI/CD pipeline. | |
| 4.2 | Software Developer | Maintains unit test scripts. | |
| 5.0 | Software Developer | Creates pull request, assigns reviewers, and add a description. | Ideally, reviewers assigned are intimately knowledgeable of the software request. Pull request description may include, but not limited to:
|
| 5.1 | Pull Request Reviewer | Performs code reviews and comments accordingly. | |
| 5.2 | Software Developer | Addresses Pull Request Reviewer's comments and adjusts programming codes where appropriate. | |
| 5.3 | Pull Request Reviewer | Approves pull request. | |
| 5.4 | Software Developer | Completes pull request. | |
| 5.5 | Software Developer | Performs branch merge, where appropriate. |
General Workflow
Include a general workflow diagram that summarizes this Work Instruction.
Diagram to be inserted.
References
List references pertinent to this Work Instruction, e.g., COP-001.
Overview
Content Tools