roadmap (entity)

Generated from solutions/ontological/lib/model/entities/roadmap/schema.ts.

Schema version: 2.

Description

A Roadmap is a living tracking document that groups Milestones under the version sections they ship in (## v0.4.0, ## v0.5.0, …). It answers “what ships when, and via which milestones” at a glance, and gives sdlc roadmap check a body it can validate: every milestone wikilink resolves, every one of those milestones’ own tasks resolve, no milestone is double-booked across two versions, and no abandoned/superseded milestone lingers unexplained.

A Roadmap is not:

• A Milestone (the delivery vehicle — target date, success criteria, member tasks). A Roadmap only references milestones by wikilink; it carries no delivery semantics of its own.
• The rationale/plan doc it points at via plan_doc (a Note) — the Roadmap is the structured, checkable index over that doc’s version sections, not the narrative itself.
• The generated /roadmap/ site page (T-9LHH-site-roadmap-generated), which is a milestone-derived view assembled at site-build time and is unrelated to this entity type.

Properties

Field	Type	Required	Description
type	string	yes	Dispatch tag for the validator framework.
schema_version	string		Numeric string version of the per-type schema this instance conforms to. Compare numerically when ordering versions. Independent of any product version. The value 0 is a documented sentinel meaning ‘pre-SDLC-managed’ — audit treats it as intentional, not stale. Optional in frontmatter: never in any per-type required set (audit flags a MISSING stamp as drift, not the validator).
id	string	yes	Immutable identifier in canonical RM-NNNN shape per D-0002-entity-identifier-shape: ‘RM-’ + 4 chars [0-9A-Z] (base-36 numbering). Never renamed once assigned. No sub-id suffix (unlike Milestone) — a roadmap is not inserted between two others.
state	string		Lifecycle stage. A roadmap is a living tracking doc, not a shippable unit, so there is deliberately no closed/done — it stays open/active until replaced (closed/superseded) or dropped (closed/abandoned).
title	string	yes	Human-readable headline. Frontmatter is canonical; the body opens with # <title> for readability.
created	string	yes	ISO date the entity was first authored.
last_reviewed	string		ISO date the entity was last reviewed. Optional: never in any per-type required set.
related	array		Cross-references. Entries are wikilinks — typically to other entities by id (slug optional per D-0002-entity-identifier-shape), but may also reference non-entity planning docs by their wikilink slug.
tags	array		Free-form labels. Required at the common level, defaulting to []. Per-type schemas may add a contains constraint (e.g. Principle requires exactly one principle/<category> tag).
need_human_review	boolean		Review-tracking flag.
created_at	string		ISO 8601 timestamp the entity was authored, finer than created. Optional: stamped by tooling that authors entities, never required.
provenance	string		What authored the entity when it was not written by hand: a skill invocation, tool, or import source (e.g. sdlc:capability-map packages/ts). Optional: absent means hand-authored.
status	string		OKF v0.2’s own document-maturity key — DISTINCT from the entity’s own lifecycle state field (do not confuse the two). Optional: absent means OKF makes no maturity claim about this document.
description	string
resource	string
stale_after	string
generated	object
verified	array
sources	array
usage_window	object
plan_doc	string	yes	Wikilink to the Note (N-XXXX, slug optional) holding the rationale/plan this roadmap tracks against, e.g. N-4F2K-sdlc-0-8-plan. roadmap check reports a plan_doc that resolves to no note file.
completion_note	string		What superseded this roadmap (or why it was abandoned). Required for any closed/* state.

Enums

state

• open/draft
• open/active
• closed/superseded
• closed/abandoned

status

• draft
• stable
• deprecated