openup: doc restructure - template alignment + design sequences (non-PSP)
Align the OpenUP markdown set to the blank templates (process-data repo, templates/openup/) per BUILD-CHECKLIST 7. Scenario step text unchanged; the EA model needs no change (brief descriptions already live in the model's UC/actor notes). - vision.md: positioning tables, stakeholder summary, user environment, needs-and-features table (R1/R2), other product requirements - use-case-model.md: per-UC specification sections (brief description, actor descriptions, named alternative/exception subsections with numbered steps, post-conditions, special requirements) - supplementary-specifications.md: category tables with priority and use-case columns + reverse coverage matrix; IDs unchanged - test/quality-check-procedure.md: migrated from Joplin (single content home); stale open items marked resolved (WI-1/WI-2) - analysis-design/sequences/: 12 PlantUML design sequences (lifelines = analysis classes, messages = design elements; per the PlantUML layout style guide) + PNG renders; embedded in Architecture Notebook 9.3 - Joplin consolidated: project content notes deleted (all live in docs/game + docs/openup); Joplin keeps the status note only
This commit is contained in:
parent
93bb034752
commit
193562cbc4
30 changed files with 1200 additions and 124 deletions
|
|
@ -213,9 +213,35 @@ associations); renders in this folder, generated by `scripts/openup/export-diagr
|
|||
|
||||
### 9.3 Interaction View
|
||||
|
||||
Not yet modeled: no sequence diagrams exist for the Skara Brae MVP (the EA model carries scenarios with
|
||||
per-step actors, not interactions). Candidate first sequences: UC-08 adventure request→combat→loot, and
|
||||
UC-01/02 auth flows. Adding them is a future work item (PlantUML prototype → EA per the workflow canon).
|
||||
Design sequences for all twelve use-case realizations. Sources are the version-controlled
|
||||
PlantUML files under `sequences/` (working copy per the PlantUML→EA workflow canon; the EA
|
||||
model carries scenarios with per-step actors). Render: `java -jar plantuml.jar -tpng
|
||||
-charset UTF-8 sequences/*.puml`; lifelines = the realization's analysis classes
|
||||
(mapping §2), messages = the actual design elements (routes and domain functions).
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
### 9.4 Operational View
|
||||
|
||||
|
|
@ -230,10 +256,11 @@ channel in the MVP (WebSocket notifications are a later-phase feature, vision.md
|
|||
|---|---|---|
|
||||
| Use Case Overview | `../requirements/use-case-overview.png` | actors, use cases, associations |
|
||||
| UC-01…UC-12 Realization | `uc-01-realization.png` … `uc-12-realization.png` | analysis classes + associations per UC |
|
||||
| UC-01…UC-12 Sequence | `sequences/uc-01-register.png` … `sequences/uc-12-level-up.png` (sources: `sequences/*.puml`) | design interactions per UC |
|
||||
| Component Architecture | `component-architecture.png` | joint component model, dependency rule |
|
||||
|
||||
All three sets are renders of the EA model (`docs/openup/model/skara-brae.eapx`) produced by
|
||||
`scripts/openup/export-diagram-images.ps1`; regenerate after model changes (read-only, layout-preserving).
|
||||
EA model renders are produced by `scripts/openup/export-diagram-images.ps1`; sequence
|
||||
renders by PlantUML from the committed sources. Regenerate after changes (drift rule).
|
||||
|
||||
## 10. References
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue