jan/skara-brae-common
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

openup: doc restructure - template alignment + design sequences (non-PSP)

Browse source 
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:
Jan-Peter von Hunnius 2026-10-05 11:22:38 +02:00
parent 93bb034752
commit 193562cbc4
30 changed files with 1200 additions and 124 deletions
Download patch file Download diff file Expand all files Collapse all files

31
docs/openup/model/BUILD-CHECKLIST.md
View file

@ -249,3 +249,34 @@ Read-only on the model: renders 14 diagrams to PNG for the markdown documents
image methods live on **ProjectInterface** (not Repository); `PutDiagramImageToFile(id,
path, 0)` = PNG; the diagram must be `OpenDiagram`-ed first or a blank 241×151 stub is
written. Regenerate after model changes; renders reflect the manual layout.
---
## 7. Documentation restructure (2026-10-05, non-PSP effort)
The OpenUP markdown set was aligned to the blank templates (process-data repo,
`templates/openup/`) — no EA model change required: scenario content is unchanged,
reformatted only; the model's UC notes/actors already carry the brief descriptions the
template sections now expose. XMI backup added 2026-10-05 via manual EA export
(`exports/xmi-backup.xml`); the COM export path is broken in this EA 15 build
(`ExportPackageXMI` filename param declared as Object in the typelib — verified across
PowerShell/JScript/VBScript, arities 2–6; `ExportProjectXML` returns false silently).
Restructured to template form:
- `requirements/vision.md` — positioning tables, stakeholder summary, user environment,
needs-and-features table (R1/R2), other product requirements.
- `requirements/use-case-model.md` — per-UC specification sections (Brief Description,
Actor Brief Descriptions, Preconditions, Basic Flow, named Alternative/Exception
subsections with numbered steps, Post-conditions, Special Requirements). Flow step
text unchanged from version 1.0.
- `requirements/supplementary-specifications.md` — category tables with Priority and
Use-Case columns + reverse Use Case Coverage Matrix; IDs unchanged; project-specific
categories (Quality Gates, Data) kept, DOC-01 added.
- `test/quality-check-procedure.md` — migrated from Joplin (single content home);
stale open items marked resolved (WI-1/WI-2).
New design content:
- `analysis-design/sequences/uc-01..uc-12.puml` + PNG renders — design sequences per
realization (lifelines = analysis classes, messages = design elements; PlantUML per
the layout style guide). Embedded in Architecture Notebook §9.3, indexed §9.5.
EA import via PlantUML `-txmi` remains optional future work (workflow canon).