Instructions for Software Requirements Compliance
- Steve Conrad
- Nico Lueck
The Software Requirements Compliance form in the GovStack Testing Platform allows software providers to self-assess their products against the functional requirements that have been developed by GovStack.
These requirements are documented in the GovStack Non-Functional Requirements specification document as well as in the Functional Requirements section of each of the GovStack Building Block specification documents.
In the first stages of the Compliance process, users will provide basic information about the software product and provide links to documentation as well as links showing that the product is containerized and can be deployed using Docker, Kubernetes, or other similar tools.
Requirement Specification and Interface Compliance
The next section of the compliance form allows the user to show how their product aligns with one or more of the GovStack Building Block specifications. There are 2 distinct ways in which compliance is measured - Interface Compliance and Requirement Specification Compliance. The tabs at the top of the screen allow the user to switch between these compliance forms. For each of these, the user can select one or more Building Blocks to submit for the compliance evaluation.
Requirement Specification Compliance
The Requirements Specification Compliance form allows the user to show which of the functional requirements defined within a Building Block specification are fulfilled by the product. These requirements are broken down into Required, Recommended, and Optional requirements.
For each of the requirements, please indicate whether the product meets that requirement. There is also a space to provide comment. If you do not know whether your product meets a particular functional or non-functional requirement, please leave the answer blank. Note that once you have selected an answer, you can click on the answer again to clear your response.
Interface (API) Compliance
Interface compliance shows whether a product supports the API interfaces that are defined for a particular Building Block. In order to fill out this section, the product must be onboarded to the API testing process. Detailed instructions on how to run this testing process against a product can be found here: Steps to check compliance against a GovStack API spec. Also note that for some products, an ‘adaptor’ may be needed to translate an existing API into the GovStack format. Documentation on building an adaptor can be found here: Adaptor Concept
On the Interface Compliance form, for each Building Block, the user is simply providing evidence that the tests have been run. The user will provide a link to the test result report that is generated when tests are run for the product.
The second part of the Interface Compliance form allows the user to self-attest that their product conforms to several of the cross-cutting requirements that are defined in the GovStack specs.
For each of the requirements, please indicate whether the product meets that requirement. There is also a space to provide comment. If you do not know whether your product meets a particular functional or non-functional requirement, please leave the answer blank. Note that once you have selected an answer, you can click on the answer again to clear your response.
Once the form is filled out, the user will verify the information and then submit the form. The compliance results will then be reviewed and once approved, will be visible on the main page of the testing platform.