state-hub/docs/workplan-convention.md
tegwick ddc3338541
All checks were successful
CI Smoke / host-smoke (push) Successful in 0s
CI Smoke / container-smoke (push) Successful in 2s
Build and Publish Multi-Context Image / build-and-push (push) Successful in 32s
Index workplan flavor and omit residuals from default views.
STATE-WP-0092: persist flavor from files, treat depends_on as the C-20
canonical edge, exclude flavor=residual from summary/next_steps/deps
unless include_residuals is set. Live primary still needs the alembic
revision applied.

Assistant: grok
Assistant-Session: 01a09dc1-b21e-77e1-919e-fcad2f82b267
2026-09-14 15:28:58 +02:00

2 KiB

State Hub Workplan Convention

New workplans in this repository use:

STATE-WP-0001-short-title.md

Workplan frontmatter should include:

id: STATE-WP-0001
type: workplan
title: "Short Title"
domain: custodian
repo: state-hub
status: proposed
owner: custodian
topic_slug: custodian
flavor: planning
depends_on: []

flavor is planning | implementation | refactoring | extension | residual. Unset is not residual. Default State Hub open views omit flavor: residual until demand or risk promotes it (STATE-WP-0092). depends_on lists blocker workplan ids; C-20 indexes that field.

During extraction, legacy CUST-WP-* plans may be bridged or migrated with their existing state_hub_workstream_id values. Write files first, then run State Hub consistency sync after this repo is registered.

When a workplan is blocked, record the unblock condition in frontmatter:

status: blocked
blocked_on: message-from:llm-connect

blocked_on uses the message-from:<agent> form so fix-consistency can cross-check unread inbox messages from that counterpart and warn when the blocker may have cleared.

Canonical workplan/workstream statuses are:

proposed, ready, active, blocked, backlog, finished, archived

Use proposed for a new plan that still needs review, ready after it has been checked against the current repo state, and finished when implementation is complete. stalled and needs_review are derived health labels, not stored frontmatter statuses.

Residuals when finishing

If work remains after a plan is complete, do not leave it only as prose or in SCOPE.md. Before status: finished, hand off each actionable residual as a live work record:

  • parkable Green/Blue → intake with origin: residual, origin_ref: <WP-id>
  • multi-step → new workplan (optional promote from residual intake)
  • founder gate/time → decision / engagement

Canon: the-custodian/canon/standards/work-record-types_v0.1.md § Residuals. Hub index/list: State Hub (not domain-local residual files).