Commit 700a8dea authored by Sabine Teufl's avatar Sabine Teufl
Browse files

Help for Formal Specification added

refs 645
parent 700e8b0e
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!--
Documentation of MIRA - Model-based Integrated Requirements Analysis.
@author becker
@author $Author$
@version $Rev$
@ConQAT.Rating GREEN Hash: 32ED2D35EACF133FD90EE3C18231ED0C
-->
<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>
<h2><u><font color="#336699">MIRA - Model-based Integrated Requirements Analysis</font></u></h2>
<h3><font color="#336699">Glossary</font></h3>
To model the problem domain, a glossary can be created. The glossary is automatically linked to the requirements specifications. Using the glossary it is easily visible whether the agreed vocabulary is used in all descriptions.
<br><br>
To create a new glossary, select <i>New Glossary</i> in the context menu of a requirements analysis.
<br><br>
<img src="./pictures/MIRA.Glossary.NewGlossary.png">
<br><br>
In the context menu of the glossary node you can then create glossary entries by clicking <i>New Entry</i>.
<br><br>
<img src="./pictures/MIRA.Glossary.NewEntry.png">
<br><br>
For each entry you should at least specify the name (the vocabulary term it represents). In the description field you should enter what this term means in your problem domain.
<br><br>
<img src="./pictures/MIRA.Glossary.NameAndDef.png">
<br><br>
An entry also has a status field (Options: New, In consolidation, Consolidated) which can be used to consolidate it with others.
Furthermore you can specify abbreviations and synonyms for the entry and add a comment.
<br><br>
For further description of the entry you can add pictures. 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.
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>
When you add a picture it is 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.
<br><br>
An alternative way to create a new glossary entry is to select a word in the requirement or use case editor, right-click on it and choose "Create glossary entry".
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>
<br><br>
You can create multiple glossary nodes with specific names (set in the properties view) to group your glossary terms.
<br><br>
<b>Connection with requirements:</b>
<br><br>
After you specified your glossary entries, they will be highlighted when you use the terms in the requirements specifications. A blue color is used to mark a name or an abbreviation of a glossary term and red is used to mark a synonym.
<br><br>
<img src="./pictures/MIRA.Glossary.Highlighting.png">
<br><br>
Furthermore matching glossary entries will be presented to you when you start typing a name and pause for a second.
If you choose one of the suggestions, the rest of the name will be inserted automatically.
<br><br>
<img src="./pictures/MIRA.Glossary.Autocomplete.png">
<br><br>
When you hold the mouse cursor for a second on a highlighted term, a pop-up will show additional information.
In the pop-up you can see the description of the glossary entry and whether the marked occurrence is an abbreviation
or a synonym of this entry. If the entry contains images, the first image is shown in the pop-up window as well.
When you click on the name in the pop-up, the editor for this glossary entry will be opened.
<br><br>
<img src="./pictures/MIRA.Glossary.PopupHover.png">
<br><br>
The glossaries always belong to one requirements analysis node. The entries of one analysis will not be highlighted in another analysis or project.
<br><br>
<b>Export:</b>
<br><br>
Like the requirements, the glossary entries can be exported as html or doc file (doc file on Windows only) with the export button on the top right of
the glossary entry editor. If you choose "Export Report Summarization" all glossary entries within the glossary are exported in one file.
</body>
</html>
\ No newline at end of file
......@@ -18,9 +18,9 @@
<h2><u><font color="#336699">MIRA - Model-based Integrated Requirements Analysis</font></u></h2>
<h4><font color="#336699">Creating a Requirements Analysis</font></h4>
<h3><font color="#336699">Creating a Requirements Analysis</font></h3>
To create a requirements analysis inside an empty new project, open the context menu of the project and select <i>Requirement Analysis</i>.
To create a requirements analysis inside an empty new project, open the context menu of the project by right-clicking on the project and select <i>Requirement Analysis</i>.
<br><br>
<img src="./pictures/MIRA.NewAnalysis.png">
......@@ -28,7 +28,7 @@ To create a requirements analysis inside an empty new project, open the context
In the same way, you can add more requirements analyses to your project.
<h4><font color="#336699">Specifying Requirements</font></h4>
<h3><font color="#336699">Specifying Requirements</font></h3>
Once you have created a requirements analysis, you can specify the contained requirements.
......@@ -95,7 +95,35 @@ Process-dependent relation types:
<img src="./pictures/MIRA.RequirementTypes.png">
<br><br>
<h4><font color="#336699">Requirement Hierarchy</font></h4>
<h4><font color="#336699">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
select <i>Formal Specification</i>.
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 the tested automatically with test suites and can be refined to the architecture level, for both see <a href="model_testing.html">Test Model</a>.
<br><br>
<img src="./pictures/MIRA.FormalSpecification.png">
<br><br>
<h4><font color="#336699">Use Cases</font></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.
Use cases and scenarios should describe the system under construction as a black-box.
<br><br>
Every use case has a <i>Detail</i> section with typical use case information. This information can be connected to the architecture.
Every scenario can be described as structured text or as a formal <a href="MSC.html">MSC</a>.
Additionally, every use case can be formalized to a <i>Formal Specification</i>.
<br><br>
<img src="./pictures/MIRA.UseCase.png">
<br><br>
<h3><font color="#336699">Requirement Hierarchy</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.
......@@ -105,14 +133,14 @@ Double-clicking on the requirements in the hierarchy opens the corresponding req
<img src="./pictures/MIRA.ShowRequirementHierarchy.png">
<br><br>
<h4><font color="#336699">Export</font></h4>
<h3><font color="#336699">Export</font></h3>
<h5>Report </h5>
<h4>Report </h4>
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.
<h5>ReqIF</h5>
<h4>ReqIF</h4>
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.
......@@ -120,7 +148,7 @@ The button <i>Export in ReqIF standard</i> opens a dialog, where all textual req
<img src="./pictures/MIRA.ReqIfExport.png">
<br><br>
<h4><font color="#336699">Verification</font></h4>
<h3><font color="#336699">Verification</font></h3>
MIRA contains automated verification and there is the possibility to save the results of manual checks.
......@@ -142,7 +170,7 @@ The list is extracted from a XML-Template, which can be modified. At the moment,
<img src="./pictures/MIRA.Checklist.png">
<br><br>
<h4><font color="#336699">Connection of use case and component architecture</font></h4>
<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>
......@@ -170,84 +198,17 @@ Double-clicking on the reference opens it in the Requirement-Specification-Edito
<img src="./pictures/MIRA.RequirementSpecificationEditor.png">
<br><br>
<h4><font color="#336699">Requirements overview</font></h4>
<h3><font color="#336699">Requirements overview</font></h3>
By double-clicking on the analysis node, an overview over all requirements opens.
By double-clicking on the requirement analysis node, an overview over all requirements opens.
<br><br>
<img src="./pictures/MIRA.RequirementsOverview.png">
<br><br>
The list of requirements can be sorted by clicking on the column headers. You can filter the requirements by inserting the filter text in the filter section. Double-clicking on a column opens the corresponding requirement.
<h4><font color="#336699">Glossary</font></h4>
To model the problem domain, a glossary can be created. The glossary is automatically linked to the requirements specifications. Using the glossary it is easily visible whether the agreed vocabulary is used in all descriptions.
<br><br>
To create a new glossary, select <i>New Glossary</i> in the context menu of a requirements analysis.
<br><br>
<img src="./pictures/MIRA.Glossary.NewGlossary.png">
<br><br>
In the context menu of the glossary node you can then create glossary entries by clicking <i>New Entry</i>.
<br><br>
<img src="./pictures/MIRA.Glossary.NewEntry.png">
<br><br>
For each entry you should at least specify the name (the vocabulary term it represents). In the description field you should enter what this term means in your problem domain.
<br><br>
<img src="./pictures/MIRA.Glossary.NameAndDef.png">
<br><br>
An entry also has a status field (Options: New, In consolidation, Consolidated) which can be used to consolidate it with others.
Furthermore you can specify abbreviations and synonyms for the entry and add a comment.
<br><br>
For further description of the entry you can add pictures. 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.
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>
When you add a picture it is 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.
<br><br>
An alternative way to create a new glossary entry is to select a word in the requirement or use case editor, right-click on it and choose "Create glossary entry".
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>
<br><br>
You can create multiple glossary nodes with specific names (set in the properties view) to group your glossary terms.
<br><br>
<b>Connection with requirements:</b>
<br><br>
After you specified your glossary entries, they will be highlighted when you use the terms in the requirements specifications. A blue color is used to mark a name or an abbreviation of a glossary term and red is used to mark a synonym.
<br><br>
<img src="./pictures/MIRA.Glossary.Highlighting.png">
<br><br>
Furthermore matching glossary entries will be presented to you when you start typing a name and pause for a second.
If you choose one of the suggestions, the rest of the name will be inserted automatically.
<br><br>
<img src="./pictures/MIRA.Glossary.Autocomplete.png">
<br><br>
When you hold the mouse cursor for a second on a highlighted term, a pop-up will show additional information.
In the pop-up you can see the description of the glossary entry and whether the marked occurrence is an abbreviation
or a synonym of this entry. If the entry contains images, the first image is shown in the pop-up window as well.
When you click on the name in the pop-up, the editor for this glossary entry will be opened.
<br><br>
<img src="./pictures/MIRA.Glossary.PopupHover.png">
<br><br>
The glossaries always belong to one requirements analysis node. The entries of one analysis will not be highlighted in another analysis or project.
<br><br>
<b>Export:</b>
<br><br>
Like the requirements, the glossary entries can be exported as html or doc file (doc file on Windows only) with the export button on the top right of
the glossary entry editor. If you choose "Export Report Summarization" all glossary entries within the glossary are exported in one file.
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>
......
......@@ -14,6 +14,8 @@
<topic label="Create, Import, Export and Load AF3-Projects" href="html/loading_standard_examples.html">
</topic>
<topic label="Requirements Engineering">
<topic href="html/MIRA.glossary.html" label="Glossary (MIRA)">
</topic>
<topic href="html/MIRA.requirements_analysis.html" label="Requirements Analysis (MIRA)">
</topic>
</topic>
......
Supports Markdown
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