Add Pretty Table project: plan, accepted documents and code
Business Case, Stakeholder Analysis, Project Plan and milestone MIL-001 with review records RC-001 to RC-003, then the Python project: PrettyTable Pokemon table, constants, pytest tests, pyproject.toml, Doxyfile, CI workflow and README. Task: MIL-001#1 Task: MIL-001#2 Task: MIL-001#3 Task: MIL-001#4 Task: MIL-001#5 Task: MIL-001#6 Task: MIL-001#7 Task: MIL-001#8
This commit is contained in:
@@ -0,0 +1,21 @@
|
||||
# System Sequence Diagram (SSD) (SSD)
|
||||
|
||||
Cite in `CrossReference` only if the instance exists (`new-artifact.sh` checks this for you):
|
||||
|
||||
- **UC** — **Required source** of every SSD: cite the use case (name and ID) it depicts
|
||||
- **DM** — Concepts behind message parameters / returned values
|
||||
- **OC** — Forward: contract per system operation shown
|
||||
|
||||
## Required sections (after Metadata / Version History)
|
||||
|
||||
1. **Source Use Case** — name and ID (`[UC-…]`) and the specific scenario.
|
||||
2. **Diagram** — PlantUML sequence diagram with just the actor and
|
||||
`:System`; **no internal objects**. Dashed return arrows for operations
|
||||
that produce a result. One scenario per diagram — separate diagrams for
|
||||
alternate/exception flows (or state them out of scope).
|
||||
3. **System Operations Table** — `Step | Message (verb phrase) | Parameters
|
||||
| Return | Use case step`. Messages match the use case's main success
|
||||
scenario step-for-step; justify any deviation. Message names become the
|
||||
Operation Contract names.
|
||||
4. **Lifecycle Notes** — creation/destruction of the System instance where
|
||||
relevant (session/transaction scope).
|
||||
Reference in New Issue
Block a user