Skip to content

Instantly share code, notes, and snippets.

@CodeMelted
Last active March 17, 2024 19:26
Show Gist options
  • Save CodeMelted/6812665ee9722e8dc03a67588d66c1da to your computer and use it in GitHub Desktop.
Save CodeMelted/6812665ee9722e8dc03a67588d66c1da to your computer and use it in GitHub Desktop.
Utilizing use cases to break down complex systems.

ID: TITLE

REFERENCE (DELETE):

Use Case - Wikipedia

END DELETE

[INTRODUCTION OR DESCRIPTION OF OVERALL FEATURE REQUEST]

Table of Contents

FUNCTIONAL DECOMPOSITION

[DESCRIBE OVERALL FUNCTIONALITY OF THE USE CASE COLLECTIONS. MAYBE INCLUDE UML USE CASE MODEL. USE MERMAID AS IT JUST BUILT IN]

Use Case Title

Description: [GENERAL DESCRIPTION OF WHAT THIS USE CASE IS ABOUT]

Actors: [A LIST OF STAKEHOLDERS (human or computer) THAT PERFORMS A BEHAVIOR WITH THIS GIVEN USE CASE]

Pre-Condition: [WHAT MUST BE TRUE BEFORE THE CASE CASE RUNS]

Post-Condition: [WHAT MUST BE TRUE AFTER THE CASE CASE RUNS]

Scenario: [SEQUENCE OF STEPS IN WHICH EVERYTHING GOES PERFECT]

Exceptions: [THE VARIATION OFF THE MAIN SEQUENCE. THIS IS USUALLY THINGS THAT GO WRONG AND HOW TO RECOVER TO GET BACK TO THE MAIN SCENARIO]

DESIGN NOTES

[UML, API EXAMPLES, etc.]

TEST NOTES

[FORMAL TESTS TO RUN, NEW TEST NOTES, CONFIGURATIONS, etc.]

REFERENCES

[ANY OUTSIDE ARTIFACTS RELATED TO THIS]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment