release-doc-generator v1.0.1
Release Doc Generator: a tool written by Tandem teams to help generate word documents that can be submitted to Agile during release. There are several different types of documents that need to be generated. An example of templates that we used in previous releases can be seen in the (https://github.com/tandemdiabetes/sugarmate-test-automation/tree/main/packages/doc-generator/reports/templates) branch. Note this tool is build using Typescript and NodeJS.
Product Requirement Specification (PRS): Product requirements as defined by product team. This is usually the first step in our software development workflow. Each PRS will be satisfied through a SRS which is described next.
Software Requirements Specification (SRS): The Software Requirements Specification formally specifies, using the language of contracts (shall, will, may), the formal requirements for the software. As such it is the basis of both software design and software validation. Tags are embedded within the document to identify requirements and provide a mechanism to ensure they are executed and validated. Software Validation ensures that the user level requirements (specified by the Software Requirements Specification) have been correctly implemented. The formal method used to demonstrate the correctness of the implementation of the SRS is the Software Validation Protocol (SVaP). Each SRS will be satisfied by a SVaP which is described next.
Software Validation Protocol (SVaP): SVaP is created and executed for the user level specification created during the Software Requirements, Software Design and Code Development SLC Phases. It challenges the implementation of the user level requirements described by Software Requirements Specification.
Software Design Specification (SDS): The Software Design Specification formally documents the design of the software. This includes specifying the structure of the code, key algorithms in the code, every unit comprising the code and the low level requirement for every module in the code. Each SDS will be satisfied by a SVeP which is described next.
Software Verification Protocol (SVeP): A SVeP is created and executed for each design level specification created during the Software Requirements, Software Design and Code Development SLC Phases. It challenges the implementation of the individual design components described by the specification. Software Verification ensures that the design level requirements (specified by the Software Design Specification (SDS) have been correctly implemented and that the Software Development Plan has been followed. The formal method used to demonstrate the correctness of the implementation of the SDS is the Software Verification Protocol (SVeP). Traceability Analysis is the formal method used to demonstrate that the Software Development Plan has been followed.