Use case template
Author: Your Name
Date: 1970-01-01
Status
Section titled “Status”Set status in frontmatter to Draft, Accepted, Superseded, or Deprecated. Link related designs in both directions when one extends or supersedes another.
Requirements documents
Section titled “Requirements documents”Put links to the requirements that informed this design here.
Affected external interfaces
Section titled “Affected external interfaces”| Name | How this design uses it |
|---|---|
| Template interface description | (optional) how this specific interface is used in this HLD |
Relevant internal interfaces
Section titled “Relevant internal interfaces”Not applicable
Whether a row is external or internal comes from the interface page access field.
Affected services
Section titled “Affected services”Services listed here are touched by this design and are not already represented by an interface row above.
| Name | How this design uses it |
|---|---|
| Template Service | (optional) how this specific service is used in this HLD |
Affected applications
Section titled “Affected applications”| Name | How this design uses it |
|---|---|
| Template Application | (optional) how this specific interface is used in this HLD (optional) how this specific service is used in this HLD |
Integration change classification
Section titled “Integration change classification”Describe how this design affects integrated consumers, using the dimensions on the Integration Change Classification page.
Threat assessment
Section titled “Threat assessment”Record what can go wrong and what will be done about it.
For each affected interface, note whether the assessment is New, Re-evaluated, or Skipped. External interfaces use a STRIDE table on the interface page. Internal interfaces use the checklist on that page. Data stores record sensitivity, retention, and access on the data-store page. The Template Database is the example.
Use case description
Section titled “Use case description”Describe the design here. Embed a LikeC4 view that already exists in the model, and link glossary terms with [[domain | Term]].
This template refers to a Template Record.