liveBook · Manning

Use case documentation

As explained in Software Design for Python Programmers

Use case documentation is the collection of artifacts that records use cases, including diagrams and written descriptions.

Use case documentation records how users achieve goals through an application. It combines UML use case diagrams with written descriptions, connecting requirements to runtime behavior. section 3.6

A written use case description typically records:

  • Name, goal, summary, actors, preconditions, and trigger. section 3.6.2
  • A primary action sequence of about ten steps or fewer, plus alternate sequences for failures. section 3.6.2
  • Postconditions, applicable nonfunctional requirements, references to other use cases, and a glossary. section 3.6.2

Search Catalogue

A customer-triggered use case describes searching a book catalogue with target book attributes and receiving matching books. Writing the steps from the actor’s viewpoint keeps the goal and interaction explicit. section 3.6.2

How Software Design for Python Programmers covers it

How deep it goes
Defines diagram and description artifacts, then specifies fields and a roughly ten-step limit for primary sequences.
Examples
Uses a book catalogue’s Search Catalogue interaction as a worked example.
What it assumes
Assumes identified application requirements and teaches the documentation structure from user goals and actors.
What you can do after
Evaluate application behavior by documenting actor goals, normal actions, alternatives, and resulting conditions.
How it connects
Ties UML use case diagrams to actors, requirements, functional requirements, and nonfunctional requirements.

Related concepts

This explainer was generated by Manning's knowledge graph from the text of Software Design for Python Programmers. The section links point to the parts of the book it draws on.