This section contains outlined instructions for how to use 'Requirements View' to analyze the quality of your requirements.
The key to quickly identifying potential problems with your requirements in Innoslate is the automatic "Quality Check" feature built into 'Requirements View'. The "Quality Check" feature runs several automatic checks run against each of your requirements. A "Quality Score" is then determined accordingly and suggestions provided on how to improve each requirement.
By default in 'Requirements View', there is a "Quality Score" column shown. Requirements which have not been scored yet will show a "Quality Score" of 0%. After running a "Quality Check" this column displays the resultant percentage 0 through 100 depending on the number of quality indicator attributes determined to be true by the automatic checks.
Built-In Quality Indicator Attributes
Innoslate provides the following quality indicator attributes built into the database schema of the Requirement class:
- Correct – i.e., describes the user’s intent and legally possible
- Complete – i.e., expresses a whole, single idea, and not portions of one or many
- Clear – i.e., explicit and not confusing to readers
- Consistent – i.e., does not conflict with other requirements
- Verifiable – i.e., proves within realistic cost and schedule that the architecture meets the requirement
- Traceable – i.e., uniquely identify, and able to be tracked to predecessor and successor lifecycle items/objects, such as functions or components
- Feasible – i.e., implement with existing or projected technology and within cost and schedule
- Modular – i.e., changes without excessive impact on other requirements
- Design – i.e., does not impose a specific solution (“what” not “how”)
Note: Only the following quality attributes are automatically checked by the "Quality Check" function: Clear, Complete, Design, and Verifiable.
Automatically Analyze All Document Entities
Below are the steps necessary to run a "Quality Check" against all the entities in your document:
Within 'Requirements View', ensure you are not currently editing a row, and click on the 'Quality Check' button.
Note: Depending on the size of the document, the "Quality Check" function may take a few seconds to run.
You will briefly see a spinner indicating the "Quality Check" function is currently running as shown below:
When the "Quality Check" function is completed, the "Quality Score" for each of the Requirement entities displayed in 'Requirements View' will now be updated as shown below. A progress bar will be displayed indicating a percentage 0 through 100, 100% being a requirement of the highest quality.
- Only the following quality attributes are automatically checked by the "Quality Check" function: Clear, Complete, Design, and Verifiable.
- Only document entities of the schema-based class Requirement are evaulated by the "Quality Check" function.