Skip to content

Commit

Permalink
create annotations use cases folder and template
Browse files Browse the repository at this point in the history
  • Loading branch information
nielsklazenga committed Oct 28, 2021
1 parent cd4141f commit 42fd56c
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 2 deletions.
39 changes: 39 additions & 0 deletions annotations-use-cases/use-case-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# 1. Use case: [short title with active verb phrase]

## 1.1. Description

[*One to two sentences that briefly describe the use case, including the primary actor’s goal*]

## 1.2. Trigger

[*Describe the event that initiates the use case*]

## 1.3. Stakeholders

### 1.3.1. Primary actor

[*Designate the actor whose goal is satisfied in this use case, and has the most significant interest in the outcome*]

### 1.3.2. Additional/supporting actors

[*List other actors that play a supporting role in the use case and impact the outcome.*]

### 1.3.3. Stakeholders

[*List the various entities who may not directly interact with the system but they may have an interest in the outcome of the use case. Stakeholder identification can aid in uncovering additional which are not readily apparent or mentioned directly by the users.*]

## 1.4. Preconditions

[*List the system state/conditions which must be true before this Use Case can be executed.*]

## 1.5. Main Success Scenario

[*Document the steps that illustrate the straightest or simplest path (the “happy path”) to accomplishing the goal. The main success scenario should describe the actors’ actions/stimuli and system response to the action or stimulus. This scenario should always end with a success end condition.*]

## 1.6. Frequency

[*Indicate how often the use case is expected to occur. This information aids designers and developers in understanding capacity requirements.*]

## 1.7. Special requirements

[*Describe any additional factors that impact the execution of the use case. These could be environmental, regulatory, organizational or market-driven in nature.*]
4 changes: 2 additions & 2 deletions mou-technical-addendum.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ There are a number of required and highly recommended fields that will be listed
* [decimalLatitude](https://hiscom.github.io/hispid/terms/#decimalLatitude)
* [coordinateUncertaintyInMeters](https://hiscom.github.io/hispid/terms/#coordinateUncertaintyInMeters)
* [eventDate](https://hiscom.github.io/hispid/terms/#eventDate)
* [parentEventID](http://hiscom.rbg.vic.gov.au/hispid/terms/bushBlitzExpedition) (BushBlitz participants only)
* [parentEventID](https://hiscom.github.io/hispid/terms/#parentEventID) (BushBlitz participants only)
* [identificationQualifier](https://hiscom.github.io/hispid/terms/#identificationQualifier)
* [identifiedBy](https://hiscom.github.io/hispid/terms/#identifiedBy)
* [identificationDate](https://hiscom.github.io/hispid/terms/#identificationDate)
Expand All @@ -88,5 +88,5 @@ There are a number of required and highly recommended fields that will be listed
* [georeferenceProtocol](https://hiscom.github.io/hispid/terms/#georeferenceProtocol)
* [minimumElevationInMeters](https://hiscom.github.io/hispid/terms/#minimumElevationInMeters), [maximumElevationinMeters](https://hiscom.github.io/hispid/terms/#maximumElevationInMeters)
* [habitat](https://hiscom.github.io/hispid/terms/#habitat)
* Higher taxonomy: [family](https://hiscom.github.io/hispid/terms/#family), [order](https://hiscom.github.io/hispid/terms/#order), [class](https://hiscom.github.io/hispid/terms/#class), [phylum](https://hiscom.github.io/hispid/terms/#phylum), [kingdom](https://hiscom.github.io/hispid/terms/#kingdom)
* Higher taxonomy: [order](https://hiscom.github.io/hispid/terms/#order), [class](https://hiscom.github.io/hispid/terms/#class), [phylum](https://hiscom.github.io/hispid/terms/#phylum), [kingdom](https://hiscom.github.io/hispid/terms/#kingdom)
* [identificationRemarks](https://hiscom.github.io/hispid/terms/#identificationRemarks)

0 comments on commit 42fd56c

Please sign in to comment.