Wiki¶
This wiki is aimed to share documents, guidelines, etc. on software engineering. The participation of all readmine-iasfbo community is welcome !
Useful Links¶
Use Case Template¶
A proposed template for the CIWS Use Case description is shown in the table below.
The Overview should give a narrative overall description of the functionality to be provided by the system from the point of view of the user responsible of the day-by-day operation of the system being developed. This should be the first input to be provided by the user.
The Flow of events is aimed at better detailing the various scenarios of using the system to achieve the goal of the Use Case. It should be compiled by interviewing the user in order to identify the different situation to be handled in the various steps summarised in the overview.
Use case details shall also be used to develop the test plan.
To this purpose, the flow of events should describe the main alternatives through if-then-else sentences.
Use cases are a starting point for test design, but since each test needs its own success criteria, use cases must provide separate post-conditions for each path
| Use Case: | Use case name, in the form: - Verb - Verb + noun - Verb + noun phrase |
| ID: | Use case identifier, in the form: - UC-xxx |
| Actors: | Actors involved in the use case |
| Overview: | High level general description |
| Pre conditions: | Condition to be met before initiating the use case |
| Main flow of events: | A numbered outline of the main success scenario. A “normal” interaction without errors, malfunctions or mishaps should be represented. If several different course are possible, the most commonly occurring should be described defining: - what happens to initiate the use case - which actors are involved - what data has to be input and being output - what stored data is needed by the use case - what happens to signal the completion of the use case |
| Alternative paths: | minor variations in the sequence of events |
| Post conditions: | Condition at completion of the use case |
| Exception paths: | Identification of possible failures and action to be taken in case of failure. |
The flow of event shall be used to develop the test plan.
Another important aspect is the definition of a glossary of terms specific to the system being developed. This shall avoid the risk of developing duplicated functions.
Programming Style¶
Issue 1.0 of our proposal on Programming Style Guideline (in Italian) is here
Standards¶
Useful Links¶