Use Case: <Title (except of spaces and Title capitalization same as file name)>

<change/remove everything in angle brackets>

Summary

  • Scope: <e.g. Authentication>
  • Level: <Cloud | Kite | Sea | Underwater | Clam>
  • Actors: <e.g. User, Administrator>
  • Brief: <Short explanation, e.g. User authenticates>
  • Status: <Draft | Later | (Decided) | Assigned | Current | (Implemented) | Done (usually same as folder)>
  • Assignee:
  • Criticality: <System Critical | Optional>

Scenarios

  • Precondition:
    • <What has to be satisfied before the use case can work?, e.g. Not authenticated>
  • Main success scenario:
    • <What is the main scenario, i.e. success scenario?, e.g. Is authenticated>
  • Alternative scenario:
    • <What is the alternative scenario, i.e. simple error handling?, e.g. Wrong credentials>
  • Error scenario:
    • <What is the other alternative scenario, i.e. fatal error handling?, e.g. Authentication block because of too many failed attempts>
  • Postcondition:
    • <What has to be valid after the scenario was run?, e.g. Access to more functions>
  • Non-functional Constraints:
    • <Some non-functional constraint, e.g. Security mechanism, Encryption, Performance, Privacy>

Development Progress

  • <Write here what was done, link to open issues etc.>

Leftovers

  • Open Issues: [#<nr>](https://issues.permaplant.net/<nr>)
  • Manual Tests: doc/tests/manual/<name>.md
  • E2E Tests: tools/e2e/<name>.md
  • Implementation Issues: [#<nr>](https://issues.permaplant.net/<nr>)

Notes