Add planning baseline: BC, SA, PP and two gateways
Create the Business Case, Stakeholder Analysis (S01 course participant, S02 Udemy coursists, S03 GitHub viewers), Project Plan and the milestone documents MIL-001 (project setup, 6 tasks) and MIL-002 (game implementation, 8 tasks) for the console Blackjack game. Register PP and MIL in the artifact registry, set the PO language to en, and link the synced Gitea milestones in the Gateway Schedule. Refs #1 Refs #2 Refs #3 Refs #4 Refs #5 Refs #6 Refs #7 Refs #8 Refs #9 Refs #10 Refs #11 Refs #12 Refs #13 Refs #14
This commit is contained in:
@@ -0,0 +1,42 @@
|
||||
# @TITLE@
|
||||
|
||||
## Metadata
|
||||
| Key | Value |
|
||||
| --- | --- |
|
||||
| ID | @ID@ |
|
||||
| CrossReference | @CROSSREF@ |
|
||||
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| @DATE@ | Accepted | @AUTHOR@ | <reviewer S-ID> | Initial version | pending |
|
||||
|
||||
Allowed Status values: `Proposed`, `Accepted`, `Rejected`, `Deprecated`, `Superseded by ADR-NNNN`.
|
||||
|
||||
---
|
||||
|
||||
## Context
|
||||
|
||||
<The forces/problem driving this decision, and the options considered.>
|
||||
|
||||
## Decision
|
||||
|
||||
<The decision that was made, stated plainly.>
|
||||
|
||||
## Consequences
|
||||
|
||||
**Positive:**
|
||||
|
||||
- <positive consequence>
|
||||
|
||||
**Negative:**
|
||||
|
||||
- <negative consequence>
|
||||
|
||||
## Affected Artifacts
|
||||
|
||||
- [<ARTIFACT-ID>] — <how this decision affects it>, or a single "-" if none
|
||||
|
||||
---
|
||||
|
||||
@LINKS@
|
||||
@@ -0,0 +1,70 @@
|
||||
# @TITLE@
|
||||
|
||||
## Metadata
|
||||
| Key | Value |
|
||||
| --- | --- |
|
||||
| ID | @ID@ |
|
||||
| CrossReference | @CROSSREF@ |
|
||||
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| @DATE@ | Accepted | @AUTHOR@ | <reviewer S-ID> | Initial version | pending |
|
||||
|
||||
---
|
||||
|
||||
## Executive Summary
|
||||
|
||||
## Methodological and Standards Foundation
|
||||
|
||||
## Problem Statement
|
||||
|
||||
## Business Opportunity
|
||||
|
||||
## Objectives
|
||||
|
||||
## Scope
|
||||
|
||||
### In Scope
|
||||
|
||||
### Out of Scope
|
||||
|
||||
## Expected Benefits
|
||||
|
||||
### Tangible Benefits
|
||||
|
||||
### Intangible Benefits
|
||||
|
||||
## Strategic Alignment
|
||||
|
||||
## Success Criteria
|
||||
|
||||
| # | Criterion | Target | Measure |
|
||||
| --- | --- | --- | --- |
|
||||
|
||||
## Risks
|
||||
|
||||
| Risk | Impact | Mitigation |
|
||||
| --- | --- | --- |
|
||||
|
||||
## Assumptions
|
||||
|
||||
## Constraints
|
||||
|
||||
## Cost–Benefit Assessment
|
||||
|
||||
| Costs | Benefits |
|
||||
| --- | --- |
|
||||
|
||||
## Stakeholders
|
||||
|
||||
| Stakeholder ID (SA) | Interest in this project |
|
||||
| --- | --- |
|
||||
|
||||
## Recommendation
|
||||
|
||||
<Proceed | Do not proceed> — <one-sentence rationale>
|
||||
|
||||
---
|
||||
|
||||
@LINKS@
|
||||
@@ -0,0 +1,113 @@
|
||||
# @TITLE@
|
||||
|
||||
## Metadata
|
||||
| Key | Value |
|
||||
| --- | --- |
|
||||
| ID | @ID@ |
|
||||
| CrossReference | @CROSSREF@ |
|
||||
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| @DATE@ | Accepted | @AUTHOR@ | <reviewer S-ID> | Initial version | pending |
|
||||
|
||||
---
|
||||
|
||||
## Purpose / Scope
|
||||
|
||||
Operationalizes: <Business Case objectives> ([BC-<n>])
|
||||
|
||||
## Canvas
|
||||
|
||||
<!-- Business Model Canvas Template -->
|
||||
<table border="1" width="100%" height="600px" style="border-collapse: collapse; vertical-align: top;">
|
||||
<!-- Upper Section -->
|
||||
<tr>
|
||||
<th colspan="2" width="20%">Key Partners</th>
|
||||
<th colspan="2" width="20%">Key Activities</th>
|
||||
<th colspan="2" width="20%">Value Propositions</th>
|
||||
<th colspan="2" width="20%">Customer Relationships</th>
|
||||
<th colspan="2" width="20%">Customer Segments</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td rowspan="3" colspan="2">
|
||||
<!--- Key Partners List -->
|
||||
<ul>
|
||||
<li></li>
|
||||
</ul>
|
||||
</td>
|
||||
<td colspan="2">
|
||||
<!--- Key Activities List -->
|
||||
<ul>
|
||||
<li></li>
|
||||
</ul>
|
||||
</td>
|
||||
<td rowspan="3" colspan="2">
|
||||
<!--- Value Propositions List -->
|
||||
<ul>
|
||||
<li></li>
|
||||
</ul>
|
||||
</td>
|
||||
<td colspan="2">
|
||||
<!--- Customer Relationships List -->
|
||||
<ul>
|
||||
<li></li>
|
||||
</ul>
|
||||
</td>
|
||||
<td rowspan="3" colspan="2">
|
||||
<!--- Customer Segments List -->
|
||||
<ul>
|
||||
<li></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th colspan="2">Key Resources</th>
|
||||
<th colspan="2">Channels</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2">
|
||||
<!--- Key Resources List -->
|
||||
<ul>
|
||||
<li></li>
|
||||
</ul>
|
||||
</td>
|
||||
<td colspan="2">
|
||||
<!--- Channels List -->
|
||||
<ul>
|
||||
<li></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<!-- Lower Section -->
|
||||
<tr>
|
||||
<th colspan="5">Cost Structure</th>
|
||||
<th colspan="5">Revenue Streams</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="5">
|
||||
<!--- Cost Structure List -->
|
||||
<ul>
|
||||
<li></li>
|
||||
</ul>
|
||||
</td>
|
||||
<td colspan="5">
|
||||
<!--- Revenue Streams List -->
|
||||
<ul>
|
||||
<li></li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
## Assumptions
|
||||
|
||||
| # | Assumption | How it can be tested |
|
||||
| --- | --- | --- |
|
||||
|
||||
## Consistency Check
|
||||
|
||||
---
|
||||
|
||||
@LINKS@
|
||||
@@ -0,0 +1,41 @@
|
||||
# @TITLE@
|
||||
|
||||
## Metadata
|
||||
| Key | Value |
|
||||
| --- | --- |
|
||||
| ID | @ID@ |
|
||||
| CrossReference | @CROSSREF@ |
|
||||
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| @DATE@ | Accepted | @AUTHOR@ | <reviewer S-ID> | Initial version | pending |
|
||||
|
||||
---
|
||||
|
||||
## Purpose and Business Goal
|
||||
|
||||
Realizes: <Business Case objective> ([BC-<n>])
|
||||
|
||||
## Participants
|
||||
|
||||
| Pool / Lane | Participant | Stakeholder ID (SA) |
|
||||
| --- | --- | --- |
|
||||
|
||||
## Process Diagram
|
||||
|
||||
<image, or link to the BPMN 2.0 diagram file + its source>
|
||||
|
||||
## Element Table
|
||||
|
||||
| Element | Type (event / activity / gateway) | Lane | Description |
|
||||
| --- | --- | --- | --- |
|
||||
|
||||
## Path Coverage
|
||||
|
||||
| Path | Start event | End event |
|
||||
| --- | --- | --- |
|
||||
|
||||
---
|
||||
|
||||
@LINKS@
|
||||
@@ -0,0 +1,50 @@
|
||||
# @TITLE@
|
||||
|
||||
## Metadata
|
||||
| Key | Value |
|
||||
| --- | --- |
|
||||
| ID | @ID@ |
|
||||
| CrossReference | @CROSSREF@ |
|
||||
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| @DATE@ | Accepted | @AUTHOR@ | <reviewer S-ID> | Initial version | pending |
|
||||
|
||||
---
|
||||
|
||||
## Purpose and Scope
|
||||
|
||||
## Diagram
|
||||
|
||||
```plantuml
|
||||
@startuml
|
||||
class Controller {
|
||||
-repo : Repository
|
||||
+operationName(param : Type) : ReturnType
|
||||
}
|
||||
class Entity
|
||||
Controller --> Entity : uses
|
||||
@enduml
|
||||
```
|
||||
|
||||
## Class Table
|
||||
|
||||
| Class | Refines (Domain Model concept) | Responsibility | Attributes | Operations |
|
||||
| --- | --- | --- | --- | --- |
|
||||
|
||||
## Method Traceability
|
||||
|
||||
| Method signature | Operation Contract / SD message |
|
||||
| --- | --- |
|
||||
|
||||
## Pattern Annotations
|
||||
|
||||
| Pattern | Classes | Rationale |
|
||||
| --- | --- | --- |
|
||||
|
||||
## Dependency Check
|
||||
|
||||
---
|
||||
|
||||
@LINKS@
|
||||
@@ -0,0 +1,35 @@
|
||||
# @TITLE@
|
||||
|
||||
## Metadata
|
||||
| Key | Value |
|
||||
| --- | --- |
|
||||
| ID | @ID@ |
|
||||
| CrossReference | @CROSSREF@ |
|
||||
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| @DATE@ | Accepted | @AUTHOR@ | <reviewer S-ID> | Initial version | pending |
|
||||
|
||||
---
|
||||
|
||||
## Purpose and Scope
|
||||
|
||||
Maps each Product Owner (PO) term to its professional IT term. PO language:
|
||||
<language, from the registry's `Languages` section>.
|
||||
|
||||
## Dictionary
|
||||
|
||||
| PO term | Language | IT term | Definition | Used as PO term in | Used as IT term in |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| <term> | <da> | <Term> | <one sentence, in the PO language> | DM | OC, SD, DCD, ERD |
|
||||
|
||||
## Rules
|
||||
|
||||
- The Domain Model, use cases and user stories use the PO term; the Operation
|
||||
Contract, Sequence Diagram, Design Class Diagram and ERD use the IT term.
|
||||
- One IT term per PO term and one PO term per IT term; no synonyms.
|
||||
|
||||
---
|
||||
|
||||
@LINKS@
|
||||
@@ -0,0 +1,54 @@
|
||||
# @TITLE@
|
||||
|
||||
## Metadata
|
||||
| Key | Value |
|
||||
| --- | --- |
|
||||
| ID | @ID@ |
|
||||
| CrossReference | @CROSSREF@ |
|
||||
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| @DATE@ | Accepted | @AUTHOR@ | <reviewer S-ID> | Initial version | pending |
|
||||
|
||||
---
|
||||
|
||||
## Purpose and Scope
|
||||
|
||||
Covers: <use cases>
|
||||
|
||||
## Diagram
|
||||
|
||||
Concepts, attributes and associations only — no operations.
|
||||
|
||||
```plantuml
|
||||
@startuml
|
||||
class Order {
|
||||
date
|
||||
status
|
||||
}
|
||||
class Customer {
|
||||
name
|
||||
}
|
||||
Customer "1" --> "0..*" Order : places
|
||||
@enduml
|
||||
```
|
||||
|
||||
## Concept Table
|
||||
|
||||
| Concept | Definition | Attributes | Source (use case / glossary) |
|
||||
| --- | --- | --- | --- |
|
||||
|
||||
## Association Table
|
||||
|
||||
| From | Association (reading direction) | To | Multiplicity |
|
||||
| --- | --- | --- | --- |
|
||||
|
||||
## Generalizations
|
||||
|
||||
| General | Specializations | Is-a justification |
|
||||
| --- | --- | --- |
|
||||
|
||||
---
|
||||
|
||||
@LINKS@
|
||||
@@ -0,0 +1,53 @@
|
||||
# @TITLE@
|
||||
|
||||
## Metadata
|
||||
| Key | Value |
|
||||
| --- | --- |
|
||||
| ID | @ID@ |
|
||||
| CrossReference | @CROSSREF@ |
|
||||
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| @DATE@ | Accepted | @AUTHOR@ | <reviewer S-ID> | Initial version | pending |
|
||||
|
||||
---
|
||||
|
||||
## Purpose and Scope
|
||||
|
||||
## Diagram
|
||||
|
||||
```plantuml
|
||||
@startuml
|
||||
hide circle
|
||||
entity CUSTOMER {
|
||||
* id : int <<PK>>
|
||||
--
|
||||
name : string
|
||||
}
|
||||
entity ORDER {
|
||||
* id : int <<PK>>
|
||||
--
|
||||
* customer_id : int <<FK>>
|
||||
}
|
||||
CUSTOMER ||--o{ ORDER : places
|
||||
@enduml
|
||||
```
|
||||
|
||||
## Entity Table
|
||||
|
||||
### <ENTITY>
|
||||
|
||||
| Attribute | Type | PK/FK | Nullable | Source (DCD class.attribute) |
|
||||
| --- | --- | --- | --- | --- |
|
||||
|
||||
## Relationship Table
|
||||
|
||||
| Entity | Cardinality | Entity | FK | Rule |
|
||||
| --- | --- | --- | --- | --- |
|
||||
|
||||
## Normalization Notes
|
||||
|
||||
---
|
||||
|
||||
@LINKS@
|
||||
@@ -0,0 +1,68 @@
|
||||
# @TITLE@
|
||||
|
||||
## Metadata
|
||||
| Key | Value |
|
||||
| --- | --- |
|
||||
| ID | @ID@ |
|
||||
| CrossReference | @CROSSREF@ |
|
||||
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| @DATE@ | Accepted | @AUTHOR@ | <reviewer S-ID> | Initial version | pending |
|
||||
|
||||
---
|
||||
|
||||
## Purpose
|
||||
|
||||
Defines how this project applies Quality Criteria (QC) checklists to real
|
||||
artifact instances, producing SQA Review Records and Go/No-Go decisions.
|
||||
|
||||
## ARB Review Workflow
|
||||
|
||||
1. **Submission** — the artifact owner submits an instance for review,
|
||||
identifying its type's QC checklist (`framework/qc/qc-*.md`).
|
||||
2. **QC Checklist Review** — the assigned reviewer (see RACI) applies the
|
||||
checklist criterion by criterion.
|
||||
3. **Review Record** — the reviewer documents the outcome as an SQA Review
|
||||
Record (`RC-*` under `docs/sqa/reviews/`).
|
||||
4. **Go/No-Go Decision** — the Accountable role for the artifact category
|
||||
decides; contested or cross-cutting cases escalate to the ARB Chair.
|
||||
5. **Sign-off** — on **Go**, the artifact's `## Version History` gets an
|
||||
`Accepted` row (the previous row becomes `Deprecated`). On **Go-with-conditions**, status stays `Proposed` until
|
||||
the Action Items are closed. On **No-Go**, the artifact returns to its
|
||||
owner.
|
||||
6. **Traceability Update** — the Traceability Matrix is updated with the
|
||||
instance and its `RC-*` reference.
|
||||
|
||||
## RACI by Artifact Category
|
||||
|
||||
Fill every cell with stakeholder IDs from the Stakeholder Analysis (`S<NN>`),
|
||||
never role names.
|
||||
|
||||
| Artifact Category | Responsible (runs the review) | Accountable (Go/No-Go owner) | Consulted | Informed |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| Strategic (Stakeholder Analysis, Business Case, BMC) | S<NN> | S<NN> | S<NN> | S<NN> |
|
||||
| Process/Business (BPMN, KPI, Milestones/Gateways) | S<NN> | S<NN> | S<NN> | S<NN> |
|
||||
| Requirements (Use Case Diagram, User Story, Use Case) | S<NN> | S<NN> | S<NN> | S<NN> |
|
||||
| Modeling/Design (Domain Model, SSD, Operation Contract, Sequence Diagram, DCD, ERD) | S<NN> | S<NN> | S<NN> | S<NN> |
|
||||
|
||||
Cross-cutting escalations and disputed verdicts are Accountable to the ARB
|
||||
Chair (`S<NN>`), overriding the category-level Accountable role.
|
||||
|
||||
## Escalation Rules
|
||||
|
||||
- A **No-Go** verdict, or any disagreement between the Responsible reviewer
|
||||
and the category's Accountable owner, escalates to the ARB Chair.
|
||||
- A reviewer may not review an instance they authored.
|
||||
- Repeated No-Go verdicts (2 or more) on the same artifact type trigger a
|
||||
review of the corresponding `QC-*` checklist itself.
|
||||
|
||||
## Cadence
|
||||
|
||||
- Reviews are triggered per artifact instance as it is produced or revised.
|
||||
- QC checklists are reviewed annually.
|
||||
|
||||
---
|
||||
|
||||
@LINKS@
|
||||
@@ -0,0 +1,35 @@
|
||||
# @TITLE@
|
||||
|
||||
## Metadata
|
||||
| Key | Value |
|
||||
| --- | --- |
|
||||
| ID | @ID@ |
|
||||
| CrossReference | @CROSSREF@ |
|
||||
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| @DATE@ | Accepted | @AUTHOR@ | <reviewer S-ID> | Initial version | pending |
|
||||
|
||||
---
|
||||
|
||||
## Purpose
|
||||
|
||||
<which Business Case success criteria this operationalizes>
|
||||
|
||||
## KPI Definitions
|
||||
|
||||
| KPI ID | Name | SMART statement | Baseline | Target | Business Case success criterion | Owner (S-ID) | Frequency & method | Data source |
|
||||
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
|
||||
| KPI-01 | | | | | | | | |
|
||||
|
||||
## Thresholds
|
||||
|
||||
| KPI ID | Acceptable | At risk | Failing |
|
||||
| --- | --- | --- | --- |
|
||||
|
||||
## Reporting
|
||||
|
||||
---
|
||||
|
||||
@LINKS@
|
||||
@@ -0,0 +1,58 @@
|
||||
# @TITLE@
|
||||
|
||||
## Metadata
|
||||
| Key | Value |
|
||||
| --- | --- |
|
||||
| ID | @ID@ |
|
||||
| CrossReference | @CROSSREF@ |
|
||||
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| @DATE@ | Accepted | @AUTHOR@ | <reviewer S-ID> | Initial version | pending |
|
||||
|
||||
---
|
||||
|
||||
## Purpose
|
||||
|
||||
<decision this gate supports>
|
||||
|
||||
## Deliverable
|
||||
|
||||
<concrete output evaluated at this gate>
|
||||
|
||||
## Go / No-Go Criteria
|
||||
|
||||
| # | Criterion (objectively checkable) | Go | No-Go |
|
||||
| --- | --- | --- | --- |
|
||||
|
||||
## Dependencies
|
||||
|
||||
| Depends on | Reason |
|
||||
| --- | --- |
|
||||
|
||||
## Traceability
|
||||
|
||||
| Business Case objective / KPI / user story | Reference |
|
||||
| --- | --- |
|
||||
|
||||
## Ownership
|
||||
|
||||
| Role | Stakeholder ID (SA) |
|
||||
| --- | --- |
|
||||
| Owner | |
|
||||
| Approving reviewer | |
|
||||
|
||||
## Target Date
|
||||
|
||||
YYYY-MM-DD — <consistency with Business Case constraints>
|
||||
|
||||
## Tasks
|
||||
|
||||
| # | Task | Summary | Needs its own Use Case/User Story? | Reference |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| 1 | <task> | <what it involves and why - becomes the Issue body> | No | |
|
||||
|
||||
---
|
||||
|
||||
@LINKS@
|
||||
@@ -0,0 +1,41 @@
|
||||
# @TITLE@
|
||||
|
||||
## Metadata
|
||||
| Key | Value |
|
||||
| --- | --- |
|
||||
| ID | @ID@ |
|
||||
| CrossReference | @CROSSREF@ |
|
||||
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| @DATE@ | Accepted | @AUTHOR@ | <reviewer S-ID> | Initial version | pending |
|
||||
|
||||
---
|
||||
|
||||
## Contract: <operationName>
|
||||
|
||||
| Item | Value |
|
||||
| --- | --- |
|
||||
| Operation | `operationName(param: Type): ReturnType` |
|
||||
| Traces to | <SSD message> in [SSD-<n>] |
|
||||
| Domain Model concepts | <Concept, Association> ([DM-<n>]) |
|
||||
|
||||
**Preconditions**
|
||||
|
||||
- <required state in Domain Model terms>
|
||||
|
||||
**Postconditions**
|
||||
|
||||
- A <Concept> instance was created.
|
||||
- <Concept> was associated with <Concept>.
|
||||
- <Concept>.<attribute> was set to <value>.
|
||||
|
||||
**Exceptions**
|
||||
|
||||
| Condition (failing precondition) | Outcome |
|
||||
| --- | --- |
|
||||
|
||||
---
|
||||
|
||||
@LINKS@
|
||||
@@ -0,0 +1,61 @@
|
||||
# @TITLE@
|
||||
|
||||
## Metadata
|
||||
| Key | Value |
|
||||
| --- | --- |
|
||||
| ID | @ID@ |
|
||||
| CrossReference | @CROSSREF@ |
|
||||
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| @DATE@ | Accepted | @AUTHOR@ | <reviewer S-ID> | Initial version | pending |
|
||||
|
||||
---
|
||||
|
||||
## Purpose
|
||||
|
||||
<what this plan schedules, and over what constraint>
|
||||
|
||||
## Planning Assumptions
|
||||
|
||||
- Week 1 starts <date>; the plan ends by <date>, per the Business Case constraint.
|
||||
- Phase length: <e.g. two weeks>.
|
||||
|
||||
## Gateway Schedule
|
||||
|
||||
| Gateway | Document | Window | Decision date | Owner | Stories | Main deliverable | Milestone |
|
||||
| --- | --- | --- | --- | --- | --- | --- | --- |
|
||||
| <name> | [MIL-<n>] | <dates> | <date> | <S-ID> | <US-…> | <deliverable> | <link once synced> |
|
||||
|
||||
```plantuml
|
||||
@startgantt
|
||||
Project starts <start YYYY-MM-DD>
|
||||
[Phase 1] starts <start YYYY-MM-DD> and ends <end YYYY-MM-DD>
|
||||
[Phase 1 Go/No-Go] happens <date YYYY-MM-DD>
|
||||
@endgantt
|
||||
```
|
||||
|
||||
## Scope Coverage
|
||||
|
||||
| Business Case scope item | Gateway |
|
||||
| --- | --- |
|
||||
|
||||
## Dependencies
|
||||
|
||||
```
|
||||
<phase 1> → <phase 2> → ...
|
||||
```
|
||||
|
||||
## Plan Risks
|
||||
|
||||
| Risk | Impact | Mitigation |
|
||||
| --- | --- | --- |
|
||||
|
||||
## Open Issues
|
||||
|
||||
- <unresolved item>
|
||||
|
||||
---
|
||||
|
||||
@LINKS@
|
||||
@@ -0,0 +1,42 @@
|
||||
# @TITLE@
|
||||
|
||||
## Metadata
|
||||
| Key | Value |
|
||||
| --- | --- |
|
||||
| ID | @ID@ |
|
||||
| CrossReference | @CROSSREF@ |
|
||||
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| @DATE@ | Accepted | @AUTHOR@ | <reviewer S-ID> | Initial version | pending |
|
||||
|
||||
Allowed Status values: `Proposed`, `Accepted`, `Rejected`, `Deprecated`. The latest reviewed row is `Accepted`; the row before it is `Deprecated`.
|
||||
|
||||
---
|
||||
|
||||
## Purpose
|
||||
|
||||
<Why this artifact type matters and what decision it supports.>
|
||||
|
||||
## Quality Criteria Checklist
|
||||
|
||||
Level: **Mandatory** criteria are the baseline every instance must meet; **Optional** criteria are advanced and may be deferred.
|
||||
|
||||
| # | Criterion | Level | ISO/IEC 25010 Characteristic(s) | Notes |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| 1 | <criterion> | Mandatory | <characteristic(s)> | |
|
||||
|
||||
## Common Defects
|
||||
|
||||
- <anti-pattern 1>
|
||||
- <anti-pattern 2>
|
||||
|
||||
## Traceability Rule
|
||||
|
||||
- Backward: <what this artifact must link to as input> ([QC-<BACKWARD-SHORT-NAME>-<NNN>])
|
||||
- Forward: <what this artifact must feed into as output> ([QC-<FORWARD-SHORT-NAME>-<NNN>])
|
||||
|
||||
---
|
||||
|
||||
@LINKS@
|
||||
@@ -0,0 +1,39 @@
|
||||
# @TITLE@
|
||||
|
||||
## Metadata
|
||||
| Key | Value |
|
||||
| --- | --- |
|
||||
| ID | @ID@ |
|
||||
| CrossReference | @CROSSREF@ |
|
||||
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| @DATE@ | Accepted | @AUTHOR@ | <reviewer S-ID> | Initial version | pending |
|
||||
|
||||
---
|
||||
|
||||
## Artifact Under Review
|
||||
|
||||
- Instance reviewed: [<INSTANCE-ID>]
|
||||
- Checklist used: [<QC-ID>] (`QC-<short-name>-<version>`, e.g. `QC-BC-001`)
|
||||
|
||||
## Checklist Results
|
||||
|
||||
| # | Criterion | Status | Evidence/Notes |
|
||||
| --- | --- | --- | --- |
|
||||
| 1 | <criterion copied from the QC checklist> | Pass/Fail/N-A | |
|
||||
|
||||
## Overall Verdict
|
||||
|
||||
<Go / Go-with-conditions / No-Go> — <rationale>
|
||||
|
||||
## Action Items
|
||||
|
||||
| Action | Owner | Due |
|
||||
| --- | --- | --- |
|
||||
| <action> | <stakeholder ID, e.g. S07> | <date> |
|
||||
|
||||
---
|
||||
|
||||
@LINKS@
|
||||
@@ -0,0 +1,54 @@
|
||||
# @TITLE@
|
||||
|
||||
## Metadata
|
||||
| Key | Value |
|
||||
| --- | --- |
|
||||
| ID | @ID@ |
|
||||
| CrossReference | @CROSSREF@ |
|
||||
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| @DATE@ | Accepted | @AUTHOR@ | <reviewer S-ID> | Initial version | pending |
|
||||
|
||||
---
|
||||
|
||||
## Purpose
|
||||
|
||||
<why this analysis exists; methodology followed>
|
||||
|
||||
## Stakeholder Summary Table
|
||||
|
||||
| ID | Name | Role/Title | Organization | Power Level | Interest Level | Quadrant | Primary Concern (Business Language) |
|
||||
| --- | --- | --- | --- | --- | --- | --- | --- |
|
||||
| S01 | | | | HIGH / MEDIUM / LOW | HIGH / MEDIUM / LOW | Manage Closely / Keep Satisfied / Keep Informed / Monitor | |
|
||||
|
||||
## Power/Interest Classification Rationale
|
||||
|
||||
## Primary Concerns and FURPS+ Mapping
|
||||
|
||||
| ID | Concern | FURPS+ attribute |
|
||||
| --- | --- | --- |
|
||||
|
||||
## Communication Requirements
|
||||
|
||||
| ID | Channel | Frequency | Deliverable | Phase / Milestone |
|
||||
| --- | --- | --- | --- | --- |
|
||||
|
||||
## Conflicting Interests and Mitigations
|
||||
|
||||
| Conflict | Stakeholders | Mitigation |
|
||||
| --- | --- | --- |
|
||||
|
||||
## Traceability Analysis
|
||||
|
||||
### Business Goal Alignment
|
||||
|
||||
| Stakeholder | Concern | Business Case objective |
|
||||
| --- | --- | --- |
|
||||
|
||||
## Sign-Off
|
||||
|
||||
---
|
||||
|
||||
@LINKS@
|
||||
@@ -0,0 +1,47 @@
|
||||
# @TITLE@
|
||||
|
||||
## Metadata
|
||||
| Key | Value |
|
||||
| --- | --- |
|
||||
| ID | @ID@ |
|
||||
| CrossReference | @CROSSREF@ |
|
||||
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| @DATE@ | Accepted | @AUTHOR@ | <reviewer S-ID> | Initial version | pending |
|
||||
|
||||
---
|
||||
|
||||
## Sequence: <operationName>
|
||||
|
||||
**Realizes:** `operationName` in [OC-<n>]
|
||||
|
||||
### Diagram
|
||||
|
||||
```plantuml
|
||||
@startuml
|
||||
participant ":Controller" as C
|
||||
participant ":Collaborator" as X
|
||||
C -> X : message(args)
|
||||
activate X
|
||||
X --> C : result
|
||||
deactivate X
|
||||
@enduml
|
||||
```
|
||||
|
||||
### Pattern Annotations
|
||||
|
||||
| Pattern (GRASP / GoF) | Applied to | Rationale |
|
||||
| --- | --- | --- |
|
||||
|
||||
### Postcondition Coverage
|
||||
|
||||
| Postcondition (from contract) | Satisfied by message |
|
||||
| --- | --- |
|
||||
|
||||
### Responsibility Check
|
||||
|
||||
---
|
||||
|
||||
@LINKS@
|
||||
@@ -0,0 +1,40 @@
|
||||
# @TITLE@
|
||||
|
||||
## Metadata
|
||||
| Key | Value |
|
||||
| --- | --- |
|
||||
| ID | @ID@ |
|
||||
| CrossReference | @CROSSREF@ |
|
||||
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| @DATE@ | Accepted | @AUTHOR@ | <reviewer S-ID> | Initial version | pending |
|
||||
|
||||
---
|
||||
|
||||
## Source Use Case
|
||||
|
||||
<Use case name> ([UC-<n>]) — scenario: <main success scenario | named alternate>
|
||||
|
||||
## Diagram
|
||||
|
||||
```plantuml
|
||||
@startuml
|
||||
actor Actor as A
|
||||
participant ":System" as S
|
||||
A -> S : verbPhrase(param)
|
||||
S --> A : result
|
||||
@enduml
|
||||
```
|
||||
|
||||
## System Operations
|
||||
|
||||
| Step | Message | Parameters | Return | Use case step |
|
||||
| --- | --- | --- | --- | --- |
|
||||
|
||||
## Lifecycle Notes
|
||||
|
||||
---
|
||||
|
||||
@LINKS@
|
||||
@@ -0,0 +1,30 @@
|
||||
# @TITLE@
|
||||
|
||||
## Metadata
|
||||
| Key | Value |
|
||||
| --- | --- |
|
||||
| ID | @ID@ |
|
||||
| CrossReference | @CROSSREF@ |
|
||||
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| @DATE@ | Accepted | @AUTHOR@ | <reviewer S-ID> | Initial version | pending |
|
||||
|
||||
---
|
||||
|
||||
## Purpose
|
||||
|
||||
Tracks backward/forward links between artifact instances so that the Business Case's
|
||||
cross-artifact traceability success criterion is measurable. A row is added or
|
||||
updated whenever an artifact instance is created or reviewed.
|
||||
|
||||
## Traceability Table
|
||||
|
||||
| Artifact Instance | Type | Upstream (Backward Link) | Downstream (Forward Link) | Last Reviewed (RC-ID) |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| [<ID>] | <type> | [<upstream-ID>] | [<downstream-ID>] | [<RC-ID>] |
|
||||
|
||||
---
|
||||
|
||||
@LINKS@
|
||||
@@ -0,0 +1,60 @@
|
||||
# @TITLE@
|
||||
|
||||
## Metadata
|
||||
| Key | Value |
|
||||
| --- | --- |
|
||||
| ID | @ID@ |
|
||||
| CrossReference | @CROSSREF@ |
|
||||
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| @DATE@ | Accepted | @AUTHOR@ | <reviewer S-ID> | Initial version | pending |
|
||||
|
||||
---
|
||||
|
||||
## Purpose
|
||||
|
||||
<What the training achieves and the risk it mitigates.>
|
||||
|
||||
## Audience and Prerequisites
|
||||
|
||||
<Who attends, what they must have read or installed.>
|
||||
|
||||
## Learning Objectives
|
||||
|
||||
By the end, a participant can:
|
||||
|
||||
- <objective>
|
||||
|
||||
## Agenda
|
||||
|
||||
| Module | Topic | Minutes |
|
||||
| --- | --- | --- |
|
||||
| 1 | <topic> | <n> |
|
||||
|
||||
## Module Notes
|
||||
|
||||
### Module 1: <topic>
|
||||
|
||||
<Key points and what the facilitator shows.>
|
||||
|
||||
## Exercises
|
||||
|
||||
### Exercise 1: <name>
|
||||
|
||||
<Task, input and expected result.>
|
||||
|
||||
## Assessment
|
||||
|
||||
<How the facilitator checks each participant, and the pass criteria.>
|
||||
|
||||
## Session Record
|
||||
|
||||
What is recorded after each session, in the project (never in the framework):
|
||||
date, facilitator, attendees, result against the assessment, feedback and
|
||||
follow-ups.
|
||||
|
||||
---
|
||||
|
||||
@LINKS@
|
||||
@@ -0,0 +1,43 @@
|
||||
# @TITLE@
|
||||
|
||||
## Metadata
|
||||
| Key | Value |
|
||||
| --- | --- |
|
||||
| ID | @ID@ |
|
||||
| CrossReference | @CROSSREF@ |
|
||||
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| @DATE@ | Accepted | @AUTHOR@ | <reviewer S-ID> | Initial version | pending |
|
||||
|
||||
---
|
||||
|
||||
## Session
|
||||
|
||||
| Item | Value |
|
||||
| --- | --- |
|
||||
| Training material | [<TRN-ID>] |
|
||||
| Date | <date of the session> |
|
||||
| Facilitator | <stakeholder ID> |
|
||||
| Format and place | <in person / online, where> |
|
||||
|
||||
## Attendees and Assessment
|
||||
|
||||
| Stakeholder ID (SA) | Attended | Assessment (Pass / Not yet) | Notes |
|
||||
| --- | --- | --- | --- |
|
||||
| <S-ID> | <Yes / No> | <Pass / Not yet> | |
|
||||
|
||||
## Feedback
|
||||
|
||||
<What attendees said worked and did not.>
|
||||
|
||||
## Follow-ups
|
||||
|
||||
| Action | Owner | Due |
|
||||
| --- | --- | --- |
|
||||
| <action, for example a repeat session or a checklist change> | <stakeholder ID> | <date> |
|
||||
|
||||
---
|
||||
|
||||
@LINKS@
|
||||
@@ -0,0 +1,55 @@
|
||||
# @TITLE@
|
||||
|
||||
## Metadata
|
||||
| Key | Value |
|
||||
| --- | --- |
|
||||
| ID | @ID@ |
|
||||
| CrossReference | @CROSSREF@ |
|
||||
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| @DATE@ | Accepted | @AUTHOR@ | <reviewer S-ID> | Initial version | pending |
|
||||
|
||||
---
|
||||
|
||||
**Format:** Brief | Casual | Fully Dressed (delete the unused sections below)
|
||||
|
||||
## Brief
|
||||
|
||||
<one paragraph: main success scenario only>
|
||||
|
||||
## Casual
|
||||
|
||||
<informal multi-paragraph narrative; may mention some alternate flows>
|
||||
|
||||
## Fully Dressed
|
||||
|
||||
- **Scope:** <system>
|
||||
- **Level:** summary | user-goal | subfunction
|
||||
- **Primary Actor:** <actor, as named in [UCD-<n>]>
|
||||
- **Stakeholders and Interests:**
|
||||
- <S-ID> — <interest>
|
||||
- **Preconditions:**
|
||||
- **Postconditions (success guarantee):**
|
||||
|
||||
### Main Success Scenario
|
||||
|
||||
1. <actor action>
|
||||
2. <system response>
|
||||
|
||||
### Extensions (Alternative / Exception Flows)
|
||||
|
||||
- 2a. <condition>:
|
||||
1. <handling> (`<<include>>` / `<<extend>>` <other use case>)
|
||||
|
||||
### Special Requirements / Business Rules
|
||||
|
||||
| Step | Rule |
|
||||
| --- | --- |
|
||||
|
||||
### Open Issues
|
||||
|
||||
---
|
||||
|
||||
@LINKS@
|
||||
@@ -0,0 +1,50 @@
|
||||
# @TITLE@
|
||||
|
||||
## Metadata
|
||||
| Key | Value |
|
||||
| --- | --- |
|
||||
| ID | @ID@ |
|
||||
| CrossReference | @CROSSREF@ |
|
||||
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| @DATE@ | Accepted | @AUTHOR@ | <reviewer S-ID> | Initial version | pending |
|
||||
|
||||
---
|
||||
|
||||
## Purpose and Scope
|
||||
|
||||
<system boundary in words>
|
||||
|
||||
## Diagram
|
||||
|
||||
```plantuml
|
||||
@startuml
|
||||
left to right direction
|
||||
actor "Name" as A1
|
||||
rectangle "System Name" {
|
||||
usecase "Verb-phrase goal" as UC1
|
||||
}
|
||||
A1 --> UC1
|
||||
@enduml
|
||||
```
|
||||
|
||||
## Actor Table
|
||||
|
||||
| Actor | Stereotype | Stakeholder ID (SA) | Goals (use cases) |
|
||||
| --- | --- | --- | --- |
|
||||
|
||||
## Use Case Table
|
||||
|
||||
| Use Case | Actor(s) | Goal |
|
||||
| --- | --- | --- |
|
||||
|
||||
## Relationships
|
||||
|
||||
| From | Relationship (`<<include>>` / `<<extend>>`) | To | Justification |
|
||||
| --- | --- | --- | --- |
|
||||
|
||||
---
|
||||
|
||||
@LINKS@
|
||||
@@ -0,0 +1,36 @@
|
||||
# @TITLE@
|
||||
|
||||
## Metadata
|
||||
| Key | Value |
|
||||
| --- | --- |
|
||||
| ID | @ID@ |
|
||||
| CrossReference | @CROSSREF@ |
|
||||
|
||||
## Version History
|
||||
| Date | Status | Author | Reviewer | Change | Commit |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| @DATE@ | Accepted | @AUTHOR@ | <reviewer S-ID> | Initial version | pending |
|
||||
|
||||
---
|
||||
|
||||
## Purpose and Scope
|
||||
|
||||
## Story List
|
||||
|
||||
### @ID@.01 — <short title>
|
||||
|
||||
**As a** <actor from [UCD-<n>]>, **I want** <goal>, **so that** <benefit>.
|
||||
|
||||
**Acceptance Criteria**
|
||||
|
||||
- Given <context>, when <action>, then <observable outcome>.
|
||||
|
||||
| Traces to | Size | INVEST exceptions |
|
||||
| --- | --- | --- |
|
||||
| [UC-<n>] or [MIL-<n>] | fits one iteration | none |
|
||||
|
||||
## INVEST Check
|
||||
|
||||
---
|
||||
|
||||
@LINKS@
|
||||
Reference in New Issue
Block a user