Tirsvad
4b3391b226
Business case BC-001, stakeholder analysis SA-001, project plan PP-001, the four milestones MIL-001 to MIL-004, the domain dictionary DICT-001, the review records RC-001 to RC-013 and the traceability matrix. The reviews end in Go: the business case, stakeholder analysis, dictionary and the four milestones are Accepted. The project plan is still Proposed; it has no checklist and is accepted directly by the Product Owner.
2.6 KiB
Artifact Registry
This project's artifact state. Types, short names and CrossReference Candidates come from the framework catalog
(framework/registry/artifact-catalog.md); this file only records where
each document lives in this project and the next version to use.
Delete rows for types you don't use. Add a row the first time you create a
document of a type. Primary File may contain a glob (e.g.
docs/uc-*/uc.md); framework/scripts/find-crossreferences.sh reads it.
| Short Name | Artifact Type | Primary File | Next Available Version |
|---|---|---|---|
| BC | Business Case | docs/business-case.md | 002 |
| SA | Stakeholder Analysis | docs/stakeholder-analysis.md | 002 |
| PP | Project Plan | docs/project-plan.md | 002 |
| MIL | Milestone / Gateway | docs/milestones/*.md | 005 |
| RC | SQA Review Record | docs/sqa/reviews/rc-*.md | 014 |
| TM | Traceability Matrix | docs/sqa/traceability-matrix.md | 002 |
| DICT | Domain Dictionary | docs/dictionary.md | 002 |
Languages
Set the PO language when the project starts; project-planning asks for it
if it is missing. An artifact of a type marked "Written in the PO language"
exists once, in that language, under its normal name (business-case.md); the
artifact skill ("One file per artifact") has the rule.
| Setting | Value |
|---|---|
| PO language | en |
| PO domain | it |
| High-level register | IT Executive English |
| Technical register | IT Professional English |
Every artifact of a type marked "Yes" below states its language and domain in
its Language and Domain Metadata rows; new-artifact.sh fills them from
PO language and PO domain. Language is a BCP 47 code (da, en).
Domain is a value from this list; add a row to introduce a domain, so a
reviewer can see at once which professional vocabulary a document uses.
| Domain | Meaning |
|---|---|
| it | Software and IT |
| medical | Healthcare and medical devices |
| construction | Construction and civil engineering |
| Artifact types | Register | Written in the PO language |
|---|---|---|
| BC, KPI, PP, MIL | IT Executive English | Yes |
| SA, BMC, BPMN, UCD, US, UC, SSD, DM, RA, GOV, DICT | IT Professional English | Yes |
| OC, SD, DCD, ERD, ADR, TM, RC, QC, source code | IT Professional English | No |
Notes
- "Next Available Version" is the zero-padded (3-digit) version to use the
next time a new document of that type is created. Increment it only when
a brand-new document is created, not when an existing document's
## Version Historygets a row. ADRuses 4 digits (0001);RCis sequential across all artifact types.