Skip to content
Snippets Groups Projects
Commit 11f9151f authored by Andreas Bayha's avatar Andreas Bayha
Browse files

MIRA: Updated help 

Updated screenshots and removed outdated (removed) parts.

Issue-Ref: 3949
Issue-Url: https://af3-developer.fortiss.org/issues/3949



Signed-off-by: default avatarAndreas Bayha <bayha@fortiss.org>
parent 84c9dae8
No related branches found
No related tags found
1 merge request!223949
Hide whitespace changes
Inline Side-by-side
Showing
with 5 additions and 382 deletions
org.fortiss.af3.rcp.help/html/MIRA.glossary.html
+ 2
− 20
View file @ 11f9151f
......@@ -31,24 +31,6 @@ You can create multiple glossary nodes with specific names (set in the propertie
In the context menu of the glossary node you can then create glossary entries by clicking <i>Entry</i>.
<br><br>
<img src="./pictures/MIRA.Glossary.NewEntry.png">
<br><br>
An alternative way to create a new glossary entry is to select a word in glossary entry, requirement source element or requirement editor, right-click on it and choose <i>Create glossary entry</i>.
If no glossary exists yet, a new one is created; if multiple glossaries exist, you are asked where the entry should be created.
<br><br>
<img src="./pictures/MIRA.Glossary.ContextMenu.png">
<br><br>
If no word is selected in the editor while choosing <i>Create glossary entry</i>, an appropriate word will be automatically chosen according to the actual context.
The chosen word is displayed in a confirmation dialog. Click the button <i>OK</i> to create a new glossary entry with this word.
If there is no appropriate word, an error dialog will appear.
<br><br>
<img src="./pictures/MIRA.Glossary.ConfirmDialog.png">
<br>
Confirm dialog
<br><br>
<img src="./pictures/MIRA.Glossary.ErrorDialog.png">
<br>
Error dialog
<h2><font color="#336699">Glossary Overview</font></h2>
......@@ -101,7 +83,7 @@ If a term is <i>consolidated</i> and a decision maker thinks that this term is n
The <i>status</i> field can be filtered in the <i>Glossary Overview</i> in order to determine the list of terms that are
<i>new</i>, <i>in consolidation</i> or <i>consolidated</i>.
<h2><font color="#336699">Connection between Glossaries, Requirement Source Elements and Requirements</font></h2>
<!--<h2><font color="#336699">Connection between Glossaries, Requirement Source Elements and Requirements</font></h2>
<br>
After you specified your glossary entries, they will be highlighted when you use the terms in the glossary entries, requirement source elements and requirements specifications.
......@@ -152,6 +134,6 @@ as this would lead to bulk lists containing nonsense.
<br><br>
<img src="./pictures/MIRA.Glossary.GlossaryOccurences.png">
-->
</body>
</html>
\ No newline at end of file
org.fortiss.af3.rcp.help/html/MIRA.requirements.html
+ 1
− 265
View file @ 11f9151f
......@@ -27,7 +27,7 @@ Change the name of a <i>Requirements</i> node in the properties view. You also c
<p>By double-clicking on the <i>Requirements</i> node, an overview over all requirements opens.<br />
<br />
<img src="./pictures/MIRA.Requirements.RequirementOverview.png" /><br />
<img src="./pictures/MIRA.RequirementsOverview.png" /><br />
<br />
The list of requirements can be sorted by clicking on the column headers of the overview list. You can filter the requirements by inserting a filter text in the filter section. Double-clicking on a column opens the corresponding requirement source element.</p>
......@@ -42,269 +42,5 @@ The list of requirements can be sorted by clicking on the column headers of the
<p>To add a new requirement, open the context menu of the requirements node. You can choose between the following requirement types:</p>
<p><img src="./pictures/MIRA.Requirements.NewRequirement.png" /><br />
<br />
<br />
<br />
Requirements consist of four respectively five sections:</p>
<ul>
<li><i>General</i>: Here all requirements management fields are located together with the fields describing the requirement informal.</li>
<li><i>Images</i>: Here you can add images to the entry.</li>
<li><i>Detail</i>: The specific fields for this requirements type are shown in this tab. Only for specific requirements.</li>
<li><i>Traces</i>: Relations between requirements and to architecture are managed here.</li>
<li><i>Safety</i>: Here you can specify safety-related information.</li>
<li><i>Comment</i>: This tab is for comments.</li>
</ul>
<p><img src="./pictures/MIRA.Requirements.Sections.png" /></p>
<h3><font color="#336699">Section General</font></h3>
<p>In this section you can enter typical requirement management information.<br />
<br />
The <i>Document Reference</i> connects the requirement with a source <i>Document</i> from the <i>Requirement Sources</i>. You can add a page number for local documents. When clicking on the reference, the document opens automatically at that page.</p>
<h3><font color="#336699">Section Images</font></h3>
<p>For further description of the entry you can add pictures in the <i>Images</i>-section. To add a picture click on the <i>Add</i> button and choose an image file in the dialog. You can add as many pictures as you want. If you add a picture, it will be copied into the <i>images</i> folder in the <i>AF3-Project-Directory</i>, next to your .af3_20 file. If you want to send the model file to someone else, you should also send the <i>images</i> folder. Each image has a description field which can be used to give information about the picture and to number the pictures. If you click on an added picture, it should be displayed in full resolution in your systems picture viewer.<br />
&nbsp;</p>
<h3><font color="#336699">Section Detail</font></h3>
<p>This section contains the typical information for this kind of requirement.<br />
&nbsp;</p>
<h3><font color="#336699">Section Traces</font></h3>
<p>Requirements can be traced to other requirements to document relations between requirements or to components to document the realization of requirements in the architecture.</p>
<h4><font color="#336699">Traces within requirements</font></h4>
<p>Requirements can be connected with each other by <i>traces</i> with different <i>relation types</i>.<br />
<br />
<img src="./pictures/MIRA.Requirements.TracesWithinRequirements.png" /><br />
<br />
Relation types are:</p>
<ul>
<li><i>Conflicted</i>: a conflict between requirements was detected, which has to be analyzed further</li>
<li><i>Contradicting</i>: requirements are irresolvable contradicting each other</li>
<li><i>Override</i>: the <i>source</i> requirement(s) is/are overridden by the <i>target</i> requirement(s)</li>
</ul>
<p>Differentiation of relation type in static relation types and process-dependent relation types:</p>
<ul>
<li>static relation types are conserved after the refining process</li>
<li>process-dependent relation types like <i>is conflicted with</i> have to be removed during the refining process</li>
</ul>
<p>Static relation types:</p>
<ul>
<li><i>is contradicting to</i></li>
<li><i>is overridden by</i> - <i>overrides</i></li>
</ul>
<p>Process-dependent relation types:</p>
<ul>
<li><i>is conflicted with</i></li>
</ul>
<p><img src="./pictures/MIRA.RequirementTypes.png" /><br />
<br />
Assign the source and target requirements by clicking the assign button.<br />
A dialog will be opened where you can place the source and target requirements by dragging and dropping the requirements in the leftmost column. The middle column contains all referred source requirements while the rightmost column comprises all target requirements. Requirements can be removed by double-clicking.<br />
<br />
<img src="./pictures/MIRA.AssignRequirements.png" /><br />
<h4><font color="#336699">Traces to component architectures</font></h4>
<p>Traces to a component document the realization of requirements in the component architecture. To set a trace to a component, press the <i>Add</i> button to create a new trace. To add a component, press the <img src="./pictures/MIRA.Requirements.ComponentButton.png" /> button. To delete a trace, select the row by clicking on the left side of the column. Then press the <i>Remove</i> button.<br />
<br />
<img src="./pictures/MIRA.Requirements.TracesToArchitecture.png" /><br />
<h3><font color="#336699">Section Safety</font></h3>
<p>In this section you can specify the safety properties of the requirement.<br />
<br />
<img src="./pictures/MIRA.Requirements.Safety.png" /><br />
<br />
Whenever the <i>Safety Relevance</i> of a trace link from the requirement to a component is set to <i>yes</i>, the SIL-level is relevant for the linked component.</p>
<h2><font color="#336699">Formal Specification</font></h2>
<p>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 select <i>Formal Specification</i>.<br />
<br />
<img src="./pictures/MIRA.NewFormalSpecification.png" /><br />
<br />
Within a formal specification different kind of models like component architectures, state machines, etc. can be used. For more information see <i>Modeling and simulation</i>. Formal specifications can be used as input for the generation of test cases, see <a href="model_testing.html">Model-based Testing</a>.<br />
<br />
<img src="./pictures/MIRA.FormalSpecification.png" /><br />
&nbsp;</p>
<h2><font color="#336699">Requirement Hierarchy</font></h2>
<p>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.ShowRequirementHierarchy.png" /></p>
<h2><font color="#336699">Review Requirements</font></h2>
<p>MIRA offers support for an automatic review of the requirements. Furthermore, it also offers the possibility to save the results of manual review.<br />
&nbsp;</p>
<h3>Automatic requirements review</h3>
<p>The button <i>Review Requirements</i> syntactically checks the structure of the textual requirements and its relations with predefined automatic checks. Requirements, that do not pass one of these checks, are marked with a decoration and details on the results are shown in the warning list of the <i>Model Markers</i>.<br />
<br />
<img src="./pictures/MIRA.Verification.png" /><br />
<br />
<br />
<br />
This list gives an overview over the automatic checks for the distinct requirements types (A: all requirements types, I: only interface behaviour requirements):<br />
&nbsp;</p>
<table border="1">
<thead>
<tr>
<th>Req. type</th>
<th>Quality factor</th>
<th>Quality indicator</th>
<th>Check 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>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>I</td>
<td>Implementation</td>
<td>Requirement connected to component in the component architecture</td>
<td>E11</td>
</tr>
</tbody>
</table>
<p>&nbsp;</p>
<p><br />
Additionally, automatic checks on the traces between requirements and from requirements to architecture are performed (A: all trace types, D: only directed relations, U: only undirected relations, E: only traces to component architectures):</p>
<p>&nbsp;</p>
<table border="1">
<thead>
<tr>
<th>Trace type</th>
<th>Quality factor</th>
<th>Quality indicator</th>
<th>Check ID</th>
</tr>
</thead>
<tbody>
<tr>
<td>A</td>
<td>Completeness</td>
<td>Existance of author.</td>
<td>E1.4</td>
</tr>
<tr>
<td>U,D</td>
<td>Completeness</td>
<td>Existance of trace type.</td>
<td>E1.4</td>
</tr>
<tr>
<td>U</td>
<td>Completeness</td>
<td>Existance of at least two target requirements in the trace.</td>
<td>E1.5</td>
</tr>
<tr>
<td>D</td>
<td>Completeness</td>
<td>Existance of at least one source and at least one target requirement in the trace.</td>
<td>E1.5</td>
</tr>
<tr>
<td>E</td>
<td>Completeness</td>
<td>Existance of a target component in the trace.</td>
<td>E1.5</td>
</tr>
<tr>
<td>A</td>
<td>Nonredundancy</td>
<td>No duplicated traces.</td>
<td>E2.2</td>
</tr>
<tr>
<td>A</td>
<td>Traceability</td>
<td>Trace status is analyzed.</td>
<td>E7.2</td>
</tr>
<tr>
<td>A</td>
<td>Consistency</td>
<td>No cyclic dependencies between directed traces.</td>
<td>E2.1</td>
</tr>
</tbody>
</table>
<p>&nbsp;</p>
<h3><font color="#336699">Support for manual reviews</font></h3>
<p><a id="check" name="check"></a>During the creation of each requirement automatically a list of checks for the manual review 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.<br />
<br />
<img src="./pictures/MIRA.Checklist.png" /></p>
<p>&nbsp;</p>
<p>&nbsp;</p>
<p>&nbsp;</p>
<p>&nbsp;</p>
<p>&nbsp;</p>
</body>
</html>
org.fortiss.af3.rcp.help/html/MIRA.requirements_analysis.html
+ 1
− 28
View file @ 11f9151f
......@@ -28,40 +28,13 @@ In the same way, you can add more requirements analysis nodes to your project.
By double-clicking on the <i>Requirements Analysis</i> node, an overview over all requirements opens.
<br><br>
<img src="./pictures/MIRA.StatisticsOverview.png">
<br><br>
The number of all artifacts is summed up in the statistics section.
<br><br>
<img src="./pictures/MIRA.RequirementsOverview.png">
<br><br>
The list of requirements can be sorted by clicking on the column headers of the overview list.
You can filter the requirements by inserting filter text in the filter section. Double-clicking on a column opens the corresponding requirement.
<br><br>
Below the requirements overview is an overview of all requirement trace that can also be filtered and sorted.
<br><br>
<img src="./pictures/MIRA.RequirementsTraces.png">
<h2><font color="#336699">Export Report</font></h2>
You can export the information contained in the <i>Requirements Analysis</i> as Html or Word-documents.</li>
<br><br>
Click right on the <i>Requirements Analysis</i> node. This opens the context menu, where you select <i>Export Report</i>.
This opens a dialog where the information can be saved as a html- or doc-files (note that the generation of doc-files is supported on Windows, only).
<br><br>
<img src="./pictures/MIRA.ExportReport.png">
<br><br>
You can filter the requirements by inserting filter text in the filter section. Double-clicking on a requirement opens the corresponding requirement.
</body>
</html>
\ No newline at end of file
org.fortiss.af3.rcp.help/html/MIRA.requirements_analysis2.html deleted 100644 → 0
+ 0
− 69
View file @ 84c9dae8
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!--
Documentation of MIRA - Model-based Integrated Requirements Analysis.
@author becker
@ConQAT.Rating YELLOW Hash: 26C75A61229717DC7D05E53111B31834
-->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>MIRA - Creating a Requirements Analysis using AutoFOCUS3 (AF3)</title>
</head>
<body>
<h1><u><font color="#336699">MIRA - Model-based Integrated Requirements Analysis</font></u></h1>
<h2><font color="#336699">Create a Requirements Analysis Node</font></h2>
To create a new <i>Requirements Analysis Node</i> in project, open the context menu of the project by right-clicking on the project and select <i>Requirements Analysis</i>.
<br><br>
<img src="./pictures/MIRA.NewAnalysis.png">
<br><br>
In the same way, you can add more requirements analysis nodes to your project.
<h2><font color="#336699">Requirements overview</font></h2>
By double-clicking on the <i>Requirements Analysis</i> node, an overview over all requirements opens.
<br><br>
<img src="./pictures/MIRA.StatisticsOverview.png">
<br><br>
The number of all artifacts is summed up in the statistics section.
<br><br>
<img src="./pictures/MIRA.RequirementsOverview.png">
<br><br>
The list of requirements can be sorted by clicking on the column headers of the overview list.
You can filter the requirements by inserting filter text in the filter section. Double-clicking on a column opens the corresponding requirement.
<br><br>
Below the requirements overview is an overview of all requirement trace that can also be filtered and sorted.
<br><br>
<img src="./pictures/MIRA.RequirementsTraces.png">
<h2><font color="#336699">Export Report</font></h2>
You can export the information contained in the <i>Requirements Analysis</i> as Html or Word-documents.</li>
<br><br>
Click right on the <i>Requirements Analysis</i> node. This opens the context menu, where you select <i>Export Report</i>.
This opens a dialog where the information can be saved as a html- or doc-files (note that the generation of doc-files is supported on Windows, only).
<br><br>
<img src="./pictures/MIRA.ExportReport.png">
<br><br>
</body>
</html>
\ No newline at end of file
org.fortiss.af3.rcp.help/html/getting_started.html
+ 1
− 0
View file @ 11f9151f
......@@ -75,6 +75,7 @@ Getting started help page.
<a href="MIRA.requirements_analysis.html">Requirements Analysis</a><br />
<a href="MIRA.requirements.html">Requirements</a><br />
<a href="MIRA.glossary.html">Glossary</a><br />
</p>
<p style="margin-left: 320px;">&nbsp;</p>
</td>
......
org.fortiss.af3.rcp.help/html/pictures/MIRA.AssignRequirements.png deleted 100644 → 0
+ 0
− 0
View file @ 84c9dae8
org.fortiss.af3.rcp.help/html/pictures/MIRA.AssignRequirements.png

40.1 KiB

org.fortiss.af3.rcp.help/html/pictures/MIRA.Checklist.png deleted 100644 → 0
+ 0
− 0
View file @ 84c9dae8
org.fortiss.af3.rcp.help/html/pictures/MIRA.Checklist.png

32 KiB

org.fortiss.af3.rcp.help/html/pictures/MIRA.ContentElements.png deleted 100644 → 0
+ 0
− 0
View file @ 84c9dae8
org.fortiss.af3.rcp.help/html/pictures/MIRA.ContentElements.png

5.53 KiB

org.fortiss.af3.rcp.help/html/pictures/MIRA.ExportReport.png deleted 100644 → 0
+ 0
− 0
View file @ 84c9dae8
org.fortiss.af3.rcp.help/html/pictures/MIRA.ExportReport.png

13.5 KiB

org.fortiss.af3.rcp.help/html/pictures/MIRA.FormalSpecification.png deleted 100644 → 0
+ 0
− 0
View file @ 84c9dae8
org.fortiss.af3.rcp.help/html/pictures/MIRA.FormalSpecification.png

8.04 KiB

org.fortiss.af3.rcp.help/html/pictures/MIRA.Glossary.Autocomplete.png deleted 100644 → 0
+ 0
− 0
View file @ 84c9dae8
org.fortiss.af3.rcp.help/html/pictures/MIRA.Glossary.Autocomplete.png

16.3 KiB

org.fortiss.af3.rcp.help/html/pictures/MIRA.Glossary.ConfirmDialog.png deleted 100644 → 0
+ 0
− 0
View file @ 84c9dae8
org.fortiss.af3.rcp.help/html/pictures/MIRA.Glossary.ConfirmDialog.png

31.1 KiB

org.fortiss.af3.rcp.help/html/pictures/MIRA.Glossary.ContextMenu.png deleted 100644 → 0
+ 0
− 0
View file @ 84c9dae8
org.fortiss.af3.rcp.help/html/pictures/MIRA.Glossary.ContextMenu.png

69.7 KiB

org.fortiss.af3.rcp.help/html/pictures/MIRA.Glossary.ErrorDialog.png deleted 100644 → 0
+ 0
− 0
View file @ 84c9dae8
org.fortiss.af3.rcp.help/html/pictures/MIRA.Glossary.ErrorDialog.png

12.9 KiB

org.fortiss.af3.rcp.help/html/pictures/MIRA.Glossary.GlossaryOccurences.png deleted 100644 → 0
+ 0
− 0
View file @ 84c9dae8
org.fortiss.af3.rcp.help/html/pictures/MIRA.Glossary.GlossaryOccurences.png

44.4 KiB

org.fortiss.af3.rcp.help/html/pictures/MIRA.GlossaryOverview.png
+ 0
− 0
View replaced file @ 84c9dae8 View file @ 11f9151f
org.fortiss.af3.rcp.help/html/pictures/MIRA.GlossaryOverview.png

29.3 KiB | W: | H:

org.fortiss.af3.rcp.help/html/pictures/MIRA.GlossaryOverview.png

15.5 KiB | W: | H:

org.fortiss.af3.rcp.help/html/pictures/MIRA.GlossaryOverview.png
org.fortiss.af3.rcp.help/html/pictures/MIRA.GlossaryOverview.png
org.fortiss.af3.rcp.help/html/pictures/MIRA.GlossaryOverview.png
org.fortiss.af3.rcp.help/html/pictures/MIRA.GlossaryOverview.png
  • 2-up
  • Swipe
  • Onion skin
org.fortiss.af3.rcp.help/html/pictures/MIRA.NewFormalSpecification.png deleted 100644 → 0
+ 0
− 0
View file @ 84c9dae8
org.fortiss.af3.rcp.help/html/pictures/MIRA.NewFormalSpecification.png

8.22 KiB

org.fortiss.af3.rcp.help/html/pictures/MIRA.RequirementTypes.png deleted 100644 → 0
+ 0
− 0
View file @ 84c9dae8
org.fortiss.af3.rcp.help/html/pictures/MIRA.RequirementTypes.png

4.77 KiB

org.fortiss.af3.rcp.help/html/pictures/MIRA.Requirements.RequirementOverview.png deleted 100644 → 0
+ 0
− 0
View file @ 84c9dae8
org.fortiss.af3.rcp.help/html/pictures/MIRA.Requirements.RequirementOverview.png

21.5 KiB

org.fortiss.af3.rcp.help/html/pictures/MIRA.Requirements.Safety.png deleted 100644 → 0
+ 0
− 0
View file @ 84c9dae8
org.fortiss.af3.rcp.help/html/pictures/MIRA.Requirements.Safety.png

5.8 KiB

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