[UserStory] High-Level Project Design

[GracchusMinor]

User Story

Essential components

• Title describes the story
• Stakeholder type is identified
• Outcome is described
• Rationale is explicit
• Acceptance criteria are verifiable and from the perspective of the stakeholder

Story

As a maintainer
I want high-level software design
so that I understand how various pieces of the software fit and work together

Acceptance Criteria

Visual representation of software design through a UML

• UML that visually represents the current states of the project
• UML must always accurately represent the current state of the code

Supporting Information

As a maintainer of this project I want a high-level view of how all of the pieces (such as build tools, code analysis tools, etc,) will work together in a single blueJ extension.

[jody]

The outcome is vague.

The acceptance criteria implies an artifact in the repository that might be better rendered dynamically (e.g., via an automated tool) or the documentation may become inconsistent with the code.