Skip to content

Roadmap

Used in the playbook Project foundation, stage 7.

Download roadmap.md — the source, as in the repository.

How to use

The template's own instructions:

Template from the UASK Engineering Hub, playbook mgmt.project-foundation, stage 7. Save as project/ROADMAP.md. Delete these comments when a section is written.

Fields

Front-matter fields and sections of the document the template creates. A section marked Optional in the template may be deleted from a copy; every other field and section stays (tools/check_artifacts.py checks this for the kinds it knows).

Field or sectionWhereRequired
titlefront matterrequired
statusfront matterrequired
versionfront matterrequired
datefront matterrequired
ownerfront matterrequired
Milestonessectionrequired
Not planned yetsectionrequired

Example

A filled-in copy for an invented product, templates/examples/roadmap.md, in the Hub repository.It shows the level of detail to aim for, not text to reuse.

example-roadmap.md
---
title: Roadmap
status: draft
version: 0.1.0
date: 2026-03-01
owner: Product Owner
---
# Roadmap — Fieldnotes
## Milestones
| # | Milestone | Exit criterion | Issues | State |
|---|---|---|---|---|
| M0 | Foundation | foundation pull request merged; ADRs decided | #1 Foundation | done |
| M1 | Offline notes | FR-1 passes AC-1 on a phone without a network | #4, #5, #6 | in progress |
| M2 | Merge and export | FR-2 and FR-3 pass AC-2 and AC-3; export check green | #9, #10 | not started |
## Not planned yet
- Voice notes — after M2, if testers ask for them.

Completion checks

A copy is complete when:

  • every required field and section above is present, in the same order, and no bracketed placeholder is left;
  • the template's comments are deleted from the copy;
  • python3 .uask/hub/tools/check_artifacts.py . reports no failure for it: front matter, sections, ids, leftover placeholders and comments (tools/check_artifacts.py, in every release bundle);
  • the exit criteria of stage 7 of the playbook Project foundation are met;
  • the owner has approved it, where the playbook asks for approval. Only the owner sets approved.

Source

templates/roadmap.md, as in the repository. Placeholders are in square brackets; comments carry the instructions.

roadmap.md
---
title: Roadmap
status: draft # draft | review | approved — only the owner sets approved
version: 0.1.0
date: YYYY-MM-DD
owner: Product Owner
---
# Roadmap — Product name
<!-- Template from the UASK Engineering Hub, playbook mgmt.project-foundation, stage 7.
Save as project/ROADMAP.md. Delete these comments when a section is written. -->
## Milestones
<!-- Milestones follow the blueprint's implementation sequence and map to tracker milestones. Each has one
exit criterion that can be checked; each line in "Issues" is one tracker issue whose acceptance
criteria cite requirement ids. Leave dates out until the owner commits to them. Without a tracker, give
each deliverable an id (I-1, I-2, …, never reused) in the "Issues" column and name its brief file. -->
| # | Milestone | Exit criterion | Issues | State |
|---|---|---|---|---|
| M0 | Foundation | foundation pull request merged; ADRs decided | #1 Foundation | … |
| M1 | … | … | … | — |
## Not planned yet
<!-- Ideas deliberately postponed, with the milestone after which to revisit them. -->
- …