Commit 3a17aada authored by Sabine Teufl's avatar Sabine Teufl
Browse files

added automated checks to help

refs 949
parent 980794c1
......@@ -6,7 +6,7 @@
@author becker
@author $Author$
@version $Rev$
@ConQAT.Rating GREEN Hash: C0D573BFE573CC5E7E4A8C245713AC00
@ConQAT.Rating YELLOW Hash: E2E30DBE407BCBC97E5D99A18112BB50
-->
<html>
......@@ -96,7 +96,7 @@ Process-dependent relation types:
<img src="./pictures/MIRA.RequirementTypes.png">
<br><br>
<h4><font color="#336699">Formal Specification</font></h4>
<h4>Formal Specification</font></h4>
A requirement can be formalized to a partial formal model, a <i>Formal Specification</i>.
To create a formal specification open the context menu of the requirement and
......@@ -115,7 +115,7 @@ can be tested as described in <a href="refinement_testing.html">Refinement Testi
<img src="./pictures/MIRA.FormalSpecification.png">
<br><br>
<h4><font color="#336699">Use Cases</font></h4>
<h4>Use Cases</h4>
<i>Use Cases</i> are a special type of requirements. Following Jackson, a use case describes the behavior of the machine to achieve the desired
effect on the environment. Every use case contains one ore more <i>Scenarios</i> describing the interaction of the machine with its environment.
......@@ -130,7 +130,24 @@ Additionally, every use case can be formalized to a <i>Formal Specification</i>.
<img src="./pictures/MIRA.UseCase.png">
<br><br>
<h4><font color="#336699">Change the Requirements Type</font></h4>
<h4>Connection of use case and component architecture</h4>
In the section <i>Detail</i> of a use case, a simple connection between use case and component architecture can be done:
<ul>
<li>setting the scope of the use case to be a component of the component architecture</li>
<li>connecting the trigger of the use case with an input port of the component architecture</li>
<li>connecting the pre-condition, min. guarantee, success guarantee of the use case with states of a state automaton of the component architecture</li>
</ul>
When the scope of a use case is connected with a component, then the reference to this use case is also listed below the component. So you can easily see which use cases belong to one component.
Double-clicking on the reference opens the corresponding Requirement-Editor.
<br><br>
<img src="./pictures/MIRA.ConnectionToArchitecture.png">
<br><br>
<h3><font color="#336699">Change the Requirements Type</font></h3>
To change from <i>Use Cases</i> to <i>Requirement</i> or inversely, click the combo box labeled <i>Type</i>, and then choose the desired type.
<br><br>
......@@ -144,33 +161,31 @@ Attention please, changing the requirements type deletes all information that is
<br><br>
<h3><font color="#336699">Requirement Hierarchy</font></h3>
<h3><font color="#336699">Requirements overview</font></h3>
The button <i>Show Requirement Hierarchy</i> opens a view,
where all relations of the current requirement are shown, divided by relation types.
Double-clicking on the requirements in the hierarchy opens the corresponding requirement in the editor.
By double-clicking on the requirement analysis node, an overview over all requirements opens.
<br><br>
<img src="./pictures/MIRA.ShowRequirementHierarchy.png">
<img src="./pictures/MIRA.RequirementsOverview.png">
<br><br>
<h3><font color="#336699">Export</font></h3>
<h4>Report </h4>
The list of requirements can be sorted by clicking on the column headers of the requirements overview.
The button <i>Export Report</i> opens a dialog, where the actual requirement can be saved as a htm- and doc-file (doc-files: Windows only!).
The button <i>Export Report Summarization</i> saves all requirements into a report.
You can filter the requirements by inserting a filter text in the filter section. Double-clicking on a column opens the corresponding requirement.
<h4>ReqIF</h4>
<h3><font color="#336699">Requirement Hierarchy</font></h3>
The button <i>Export in ReqIF standard</i> opens a dialog, where all textual requirements descriptions and their hierarchy can be exported to ReqIF-format.
The button <i>Show Requirement Hierarchy</i> opens a view,
where all relations of the current requirement are shown, divided by relation types.
Double-clicking on the requirements in the hierarchy opens the corresponding requirement in the editor.
<br><br>
<img src="./pictures/MIRA.ReqIfExport.png">
<img src="./pictures/MIRA.ShowRequirementHierarchy.png">
<br><br>
<h3><font color="#336699">Verification</font></h3>
<h4>Automated verification</h3>
MIRA offers support for automatic verification of requirements. Furthermore, it also offers the possibility to save the results of manual checks.
<br><br>
......@@ -184,41 +199,114 @@ Requirements, that do not pass verification, are marked with a decoration and de
<br><br>
This list gives an overview over the implemented checks for the distinct requirements types (A: all requirements types, U: only use case):
<br><br>
<table border="1">
<thead>
<tr>
<th>Req. type</th>
<th>Qualitätsfaktor</th>
<th>Qualitätsindikator</th>
<th>ID</th>
</tr>
</thead>
<tbody>
<tr>
<td>A</td>
<td>Completeness</td>
<td>Existance of title and description</td>
<td>E1.4</td>
</tr>
<tr>
<td>A</td>
<td>Completeness</td>
<td>Existance of a complete description, TODO has to be empty</td>
<td>E1.5</td>
</tr>
<tr>
<td>A</td>
<td>Nonredundancy</td>
<td>Nonredundancy of title or description</td>
<td>E2.1</td>
</tr>
<tr>
<td>U</td>
<td>Nonredundancy</td>
<td>Nonredundancy of title and actors</td>
<td>E2.2</td>
</tr>
<tr>
<td>U</td>
<td>Nonredundancy</td>
<td>Nonredundancy of scenario steps</td>
<td>E2.4</td>
</tr>
<tr>
<td>U</td>
<td>Nonredundancy</td>
<td>Nonredundancy of scenario names within one use case</td>
<td>E2.5</td>
</tr>
<tr>
<td>A</td>
<td>Traceability</td>
<td>Requirement status at least analyzed</td>
<td>E7.2</td>
</tr>
<tr>
<td>A</td>
<td>Prioritization</td>
<td>Requirement prioritized</td>
<td>E8</td>
</tr>
<tr>
<td>A</td>
<td>Consistency</td>
<td>Requirements not conflicted</td>
<td>E9.1</td>
</tr>
<tr>
<td>U</td>
<td>Consistency</td>
<td>Consistent actors of scenario steps and use case</td>
<td>E9.3</td>
</tr>
<tr>
<td>A</td>
<td>Refinement</td>
<td>Refinement of declined requirements is also declined</td>
<td>E10.3</td>
</tr>
</tbody>
</table>
<br><br>
<h4>Support for manual verification</h3>
During the creation of each requirement automatically a list of checks is created in a second tab called <i>Checklist</i>.
The list is extracted from a XML-Template, which can be modified. At the moment, this XML-Template is contained in the source-folder of MIRA.
The list is extracted from a XML-template, which can be modified. At the moment, this XML-template is contained in the source-folder of MIRA.
<br><br>
<img src="./pictures/MIRA.Checklist.png">
<br><br>
<h3><font color="#336699">Connection of use case and component architecture</font></h3>
In the section <i>Detail</i> of a use case, a simple connection between use case and component architecture can be done:
<ul>
<li>setting the scope of the use case to be a component of the component architecture</li>
<li>connecting the trigger of the use case with an input port of the component architecture</li>
<li>connecting the pre-condition, min. guarantee, success guarantee of the use case with states of a state automaton of the component architecture</li>
</ul>
<h3><font color="#336699">Export</font></h3>
When the scope of a use case is connected with a component, then the reference to this use case is also listed below the component. So you can easily see which use cases belong to one component.
Double-clicking on the reference opens the corresponding Requirement-Editor.
<h4>Report </h4>
<br><br>
<img src="./pictures/MIRA.ConnectionToArchitecture.png">
<br><br>
The button <i>Export Report</i> opens a dialog, where the actual requirement can be saved as a htm- and doc-file (doc-files: Windows only!).
The button <i>Export Report Summarization</i> saves all requirements into a report.
<h3><font color="#336699">Requirements overview</font></h3>
<h4>ReqIF</h4>
By double-clicking on the requirement analysis node, an overview over all requirements opens.
The button <i>Export in ReqIF standard</i> opens a dialog, where all textual requirements descriptions and their hierarchy can be exported to ReqIF-format.
<br><br>
<img src="./pictures/MIRA.RequirementsOverview.png">
<img src="./pictures/MIRA.ReqIfExport.png">
<br><br>
The list of requirements can be sorted by clicking on the column headers of the requirements overview.
You can filter the requirements by inserting a filter text in the filter section. Double-clicking on a column opens the corresponding requirement.
</body>
</html>
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment