Difference between revisions of "Form:Use Case Definition"

From City Data Model Project Collaboratory
Jump to navigation Jump to search
Line 11: Line 11:
 
{{{for template|Use Case}}}
 
{{{for template|Use Case}}}
 
{| class="formtable"
 
{| class="formtable"
! Usage Scenario:  
+
! Summary: Short description (<= 280 characters).
| {{{field|Usage Scenario|input type=textarea|mandatory}}}
+
The summary should identify the goal and one or more value proposition(s) in the form «[<Verb>] <direct object>»
 +
| {{{field|Summary|input type=textarea|mandatory}}}
 
|-
 
|-
! Scenario Licensing:  
+
! Description: A more extended description of the use case. It should provide sufficient context to provide insight into the data that needs to be exchanged and processed.
| {{{field|Scenario License|mandatory|input type=dropdown|values from category=License}}}
+
| {{{field| Description |input type=textarea|mandatory}}}
<!-- crude initial set of pages defined in Category:License -->
 
 
|-
 
|-
 
! Actors:  
 
! Actors:  
 
| {{{field| Actors |input type=textarea|mandatory}}}
 
| {{{field| Actors |input type=textarea|mandatory}}}
 
|-
 
|-
! Basic Flow of Events:  
+
! Basic Flow of Events: The sequence of events that occur during the normal flow of this use case with any notes
 
| {{{field|Basic Flow of Events|input type=textarea|mandatory}}}
 
| {{{field|Basic Flow of Events|input type=textarea|mandatory}}}
 
|-
 
|-
! Data Flows:  
+
! Flow Exceptions: If applicable, highlighted alternative flow(s) of events that reveal the need for additional data to be exchanged among the actors of the use case.
| {{{field|Data Flows|input type=textarea}}}
+
| {{{field|Flow Exceptions|input type=textarea}}}
 +
|-
 +
! Information Requirements: This is a very high-level description, for example, "origin location, destination location, and travel preferences". Details can be hashed out later and shown in the diagrams; this can be updated later to provide correspondence linkages to the defined data concepts in the Information View. While not technically required to define a use case, this field should be populated prior to beginning work on the data definitions.
 +
| {{{field|Information Requirements|input type=textarea}}}
 +
|-
 +
! Scenario Licensing:
 +
| {{{field|Scenario License|mandatory|input type=dropdown|values from category=License}}}
 +
<!-- crude initial set of pages defined in Category:License -->
 
|-
 
|-
 
! Other Licensing Notes:
 
! Other Licensing Notes:
Line 34: Line 41:
 
{{{for template|Supplementary Figures|label=Supplementary Figure(s)|multiple}}}
 
{{{for template|Supplementary Figures|label=Supplementary Figure(s)|multiple}}}
 
{| class="formtable"
 
{| class="formtable"
! Figure:  
+
! Figure(s): Include any figures needed to assist the user in better understanding the scenario. Any figures should be explained and referenced by either the description or the flow of events.
 
| {{{field|Figure|uploadable}}}
 
| {{{field|Figure|uploadable}}}
 
|  
 
|  

Revision as of 17:42, 12 April 2021

This is the "Use Case Definition" form. To create a page with this form, enter the page name below; if a page with that name already exists, you will be sent to a form to edit that page.