UC:Use case example: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[checked revision][checked revision]
(Intention)
({{mirror}})
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{UseCase|example|example|title=Example}}
{{mirror}}
{{UC title}}
This article shows and explains the structure of a good use case. For an actual example see [[IS:UC:RailwayInfrastructureRecording]].
 
This section should be used for a header or introduction. To get more information on use cases and how to describe them, see [[Dev:Use cases]]. The headline is made with [[Template: UC title]] (type <nowiki>{{UC title}}</nowiki>)
{{UC description}}
Please, describe the use case here. The headline is made with [[Template: UC description]] (type <nowiki>{{UC description}}</nowiki>)
{{UC flows}}
In this section the data flows should be drafted. The headline is made with [[Template: UC flows]] (type <nowiki>{{UC flows}}</nowiki>)
{{UC interference}}
Which data interferences are there? The headline is made with [[Template: UC interference]] (type <nowiki>{{UC interference}}</nowiki>)
{{UC data}}
How can the data be characterized? Explain this in the following subsections. The headline is made with [[Template: UC data]] (type <nowiki>{{UC data}}</nowiki>)
{{UC update}}
How often are the data updated? Does this happen routinely? The headline is made with [[Template: UC update]] (type <nowiki>{{UC update}}</nowiki>)
{{UC complexity}}
How complex is the exchanged data? The headline is made with [[Template: UC complexity]] (type <nowiki>{{UC complexity}}</nowiki>)
{{UC focus}}
What is the focus of the data? How can the whole picture be described? The headline is made with [[Template: UC focus]] (type <nowiki>{{UC focus}}</nowiki>)
{{UC elements}}
Please list all elements that are part of the data in this use case. The headline is made with [[Template: UC elements]] (type <nowiki>{{UC elements}}</nowiki>)

Latest revision as of 21:42, 23 January 2020

🗒️ This page is mirrored from page UC:Use case example in The railML® 3 wiki.
The name of the use case
Subschema: Subschema missing!
Stift.png (version(s) Demoversion)
For general information on use cases see UC:Use cases


This page should be considered as an annex to the guides of the section use-cases (link to the railML® website). If inconsistencies are found, then guides of the section use-cases (link to the railML® website) have higher priority.

Use case / Anwendungsfall

This section should be used for a header or introduction. The headline is made with Template: UC title (type {{UC title}})

Description / Beschreibung

What is the application behind the use case? Which data in general is required? Which kind of tool/application provides this data? Who usually consumes it? Which data is not included (if not obvious)? Define the boundaries of the use case and the relevant data.

Data Flows and Interfaces / Datenflüsse und Schnittstellen

Which data flows exist? How often is data exchanged? What is the granularity? How does it change over time, if it does at all? Diagrams/images would be helpful to visualize the dataflow.

Dependent railML® domains / {{deu|Abhängige railML

Please describe what domains of railML the use case is dependent upon if any, e.g. infrastructure, timetable, rolling stock, interlocking. Please also clarify if this dependency is essential for the use case or considered optional.

Characterizing Data / Charakterisierung der Daten

Please describe what data is exchanged for the use case. What is part and what is not part of the data exchange. What level of detail is usually included. On what does this level of detail depend. This description is usually the starting point for the next level of determining a more formalized and detailed table of the domain elements necessary for the use case. This description may also reference other existing use cases.

Sub-use cases / Teil - Usecases

Are there any partial use cases distinguished, which build on each other?

Additional remarks / Zusätzliche Bemerkungen

References / Verweise