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,26 @@
|
||||
# Sequence Diagram (Design) (SD)
|
||||
|
||||
Cite in `CrossReference` only if the instance exists (`new-artifact.sh` checks this for you):
|
||||
|
||||
- **OC** — **Required source**: the contract whose postconditions each diagram realizes
|
||||
- **DCD** — Forward: classes/methods these messages become
|
||||
|
||||
## Required sections (after Metadata / Version History)
|
||||
|
||||
One block per realized Operation Contract:
|
||||
|
||||
1. **Realizes** — the contract (`[OC-…]`) and its operation name.
|
||||
2. **Diagram** — PlantUML sequence diagram: sync (solid filled arrow),
|
||||
async (open arrow), returns (dashed); activations matching the call
|
||||
nesting; `create` / `destroy` shown for transient objects;
|
||||
`loop` / `alt` / `opt` fragments for conditional/repeated behavior.
|
||||
3. **Pattern Annotations** — table `Pattern (GRASP/GoF) | Applied to |
|
||||
Rationale`. Patterns are labelled, never implicit.
|
||||
4. **Postcondition Coverage** — `Postcondition | Satisfied by message`;
|
||||
every postcondition of the contract must be covered.
|
||||
5. **Responsibility Check** — a short note showing no god-object receives
|
||||
all messages (low coupling, high cohesion).
|
||||
|
||||
## Terminology
|
||||
|
||||
Use the IT terms from the dictionary (`DICT`), not the PO terms the Domain Model uses.
|
||||
Reference in New Issue
Block a user