Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
title: "Generated Reference Sync Coupling"
legend: PROCESS
lane: bad-code
owner: "METHOD maintainers"
priority: medium
acceptance_criteria:
- "The note names the current bad behavior: refreshing generated reference docs like docs/MCP.md or docs/CLI.md currently requires `method sync ship`, which also mutates repo-level ship surfaces such as BEARING and CHANGELOG."
- "The proposal defines a bounded way to regenerate reference docs without touching ship-only artifacts that are supposed to move on merged main."
- "The contract keeps full `method sync ship` as the post-merge main maneuver rather than weakening that workflow."
- "The contract specifies regression expectations proving a scoped reference-doc refresh leaves BEARING and CHANGELOG unchanged on branch-local runs."
---
Comment thread
flyingrobots marked this conversation as resolved.

# Generated Reference Sync Coupling

Refreshing generated reference docs during PR work currently requires
running `method sync ship`, even when the only intended output is a file
like `docs/MCP.md` or `docs/CLI.md`. That full ship maneuver also
touches repo-level artifacts such as `docs/BEARING.md` and
`CHANGELOG.md`, which are explicitly supposed to reflect merged `main`
state rather than branch-local review work.

In practice, that means a small documentation regeneration step creates
unrelated branch noise that then has to be manually reverted. This is
the sort of coupling that wastes review time and makes agents less
confident about running the generator they actually need.

## Proposed Contract

- Current bad behavior:
regenerating generated reference docs on a feature branch should not
require mutating ship-only artifacts whose truth is tied to merged
`main`.
- Desired split:
keep `method sync ship` as the full post-merge ship maneuver, and add
a dedicated branch-local reference-doc refresh surface such as
`method sync refs`, backed by a TypeScript helper such as
`generateReferenceDocs()`, for regenerating reference docs without
mutating ship-only artifacts.
- Scoped outputs:
`method sync refs` should refresh the current generated reference
signposts exactly: `ARCHITECTURE.md`, `docs/CLI.md`, `docs/MCP.md`,
and `docs/GUIDE.md`. It must not edit ship-only artifacts such as
`docs/BEARING.md` or `CHANGELOG.md`.
- Safety:
`method sync refs` MUST print the list of refreshed targets, and
`generateReferenceDocs()` MUST return the same target list for MCP or
other callers. That surfaced scope must name the exact refreshed
targets (`ARCHITECTURE.md`, `docs/CLI.md`, `docs/MCP.md`,
`docs/GUIDE.md`) and exclude ship-only files such as
`docs/BEARING.md` and `CHANGELOG.md`.

## Non-goals

- Remove or weaken `method sync ship`.
- Make `BEARING` or `CHANGELOG` branch-local artifacts again.
- Solve every generated-document refresh problem in the same slice.
72 changes: 72 additions & 0 deletions docs/method/backlog/bad-code/PROCESS_typed-frontmatter-access.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
title: "Typed Frontmatter Access"
legend: PROCESS
lane: bad-code
owner: "METHOD maintainers"
priority: medium
acceptance_criteria:
- "The note names the current lossy behavior in src/frontmatter.ts: parsed YAML values are stringified, which discards arrays, booleans, and richer scalar distinctions."
- "The proposal defines a bounded typed-read surface for frontmatter without requiring every existing caller to migrate in one slice."
- "The contract keeps simple update behavior explicit, including what types are supported for round-trip writes."
- "Regression coverage proves fields such as acceptance_criteria arrays and boolean-like frontmatter survive typed reads without collapsing to plain strings."
---

# Typed Frontmatter Access

METHOD's frontmatter parser currently converts every parsed YAML value
to `String(value)` before handing it to callers. That makes the read
surface simple, but it is also lossy: arrays, booleans, and richer YAML
values collapse into plain strings.

That tradeoff is no longer cheap. Backlog items now carry structured
fields such as `acceptance_criteria`, and newer agent-first features
like backlog query or next-work want real metadata rather than
hand-reconstructed strings.

## Current Bad Behavior

- `acceptance_criteria` arrays lose structure on read.
- Boolean-like fields cannot be distinguished from arbitrary strings
once they pass through the current helper.
- Agents and higher-level features have to re-parse raw markdown or
avoid using the existing frontmatter API when they need structured
truth.

## Proposed Contract

- Add a typed read path:
keep the current string-oriented helpers for compatibility, but add a
typed frontmatter read surface that returns YAML-native values for the
bounded scalar and collection types METHOD actually uses.
- Supported first-cut types:
strings, booleans, numeric YAML scalars, and arrays of strings for
fields like `acceptance_criteria` or `source_files`. Quoted numeric
literals such as `"123"` remain strings per YAML parsing semantics,
and `null` does not become a supported typed value in the first cut.
- Compatibility:
existing callers that only need simple string metadata do not have to
migrate in the same slice.
- Typed writes:
add a typed write or merge helper that validates frontmatter updates
against the supported schema before persisting. A write that would
downgrade a typed field, such as replacing an array with a string,
MUST fail by default with an error that names the field, expected
shape, and attempted shape. A later explicit opt-in downgrade path may
exist, but it must be deliberate rather than silent.
Comment thread
flyingrobots marked this conversation as resolved.
Example error:
`Cannot downgrade typed field 'acceptance_criteria': expected array<string>, attempted string`.
- Legacy helpers:
`updateFrontmatter()` remains available for plain string-only metadata
but MUST NOT be used for schema-backed typed fields such as
`acceptance_criteria`.
- Migration path:
automated writers such as the GitHub adapter's `pushItem()` must be
audited and moved to the typed write surface for any schema-backed
frontmatter before typed reads become the default read contract.

## Non-goals

- Support every obscure YAML feature.
- Migrate every existing frontmatter caller in one sweep.
- Turn frontmatter into a free-form database with no document-level
contract.
84 changes: 84 additions & 0 deletions docs/method/backlog/cool-ideas/PROCESS_backlog-query-surface.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
---
title: "Backlog Query Surface"
legend: PROCESS
lane: cool-ideas
owner: "METHOD maintainers"
priority: medium
acceptance_criteria:
- "The note defines both a CLI and MCP surface for enumerating backlog items as structured data."
- "The result schema includes repo path plus parsed frontmatter fields such as lane, legend, title, priority, and owner when present."
- "The surface supports bounded filtering or selection by lane, legend, and priority without requiring manual filesystem grep."
- "The proposal explicitly says higher-level features like `next-work` may build on this query surface but do not have to land in the same slice."
---

# Backlog Query Surface

Agents and humans currently have to inspect `docs/method/backlog/`
directly or fall back to shell grep whenever they want a structured
answer to simple questions like "show all `bad-code` items", "what
`up-next` items exist?", or "which items have `priority: medium`?".

That friction shows up again and again in coordination work. A native
backlog query surface would make METHOD better for both day-to-day human
triage and agent workflows that need real repo truth without re-parsing
markdown ad hoc.

## Proposed Contract

- Surface:
ship both a CLI query such as
`method backlog list [--lane <lane>] [--legend <legend>] [--priority <priority>] [--json]`
and an MCP tool such as `method_backlog_query`.
- Shared output:
CLI `--json` and MCP return the same structured result object with
item arrays plus summary counts.
- Schema dependency:
implementing the richer item shape requires extending
`BacklogItem` in `src/domain.ts` with `title`, `priority`, `owner`,
and `has_acceptance_criteria`, and depends on typed frontmatter access
being available for those fields.
Comment thread
flyingrobots marked this conversation as resolved.
- Implementation phasing:
this surface may ship in two phases. Phase one may return only the
current `BacklogItem` identity fields (`path`, `stem`, `slug`, `lane`,
`legend`) without waiting for typed frontmatter. Phase two adds
`title`, `priority`, `owner`, and `has_acceptance_criteria` once
typed frontmatter and the `BacklogItem` extension land. If those
dependencies are already available, the full surface may ship in one
slice instead.
- Item shape:
each returned item includes existing backlog identity fields
(`path`, `stem`, `slug`, `lane`, `legend`) plus extended metadata
fields `title`, `priority`, `owner`, and
`has_acceptance_criteria: boolean` where that boolean is `true` when
the `acceptance_criteria` field exists in frontmatter and `false`
otherwise.
- Filtering:
the first slice should support bounded filtering by lane, legend, and
priority. Unfiltered output must stay bounded rather than dumping the
entire backlog at once: accept `limit` / `--limit` with default `50`
and maximum `100`, return at most that many items, and include
`truncated: boolean` plus optional `total_count` when additional
matches exist.
- Relationship to higher-level features:
surfaces like `method next` may build on this query result, but the
query surface should remain useful on its own as a plain inventory and
selection primitive.

## Agent-First Rationale

- Agents need:
deterministic structured backlog data without scraping markdown by
hand every turn.
- Humans benefit too:
the same command becomes a reliable triage tool for backlog grooming,
planning, and design-pull decisions.
- Explainability:
when higher-level recommendation features rank items, they should be
able to cite this query surface as the source of the underlying
backlog facts.

## Non-goals

- Auto-pull or reorder backlog items just because they match a filter.
- Replace human planning judgment with a raw listing command.
- Fold recommendation logic into the base query surface.
183 changes: 183 additions & 0 deletions docs/method/backlog/cool-ideas/PROCESS_design-doc-template-catalog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,183 @@
---
title: "Design Doc Template Catalog"
legend: PROCESS
lane: cool-ideas
owner: "METHOD maintainers"
priority: medium
acceptance_criteria:
- "The note defines a bounded catalog of at least four design-doc templates instead of a single universal scaffold."
- "Each template states when it should be used plus the sections or prompts it must contain."
- "The proposal preserves the current shared core sections and separates them from template-specific additions."
- "The note explains how `method pull` or a future scaffolder could select a template without requiring implementation in the same slice."
---

# Design Doc Template Catalog

METHOD's current design docs share a strong baseline scaffold, but the
same outline is not equally informative for every slice. A feature
delivery cycle, a contract-surface change, a cleanup refactor, a
docs-policy change, and an exploratory spike do not all need the same
questions emphasized in the same order.

That mismatch produces placeholder sections, strained prose, and design
docs that technically satisfy the scaffold while still being weaker than
they should be. A small template catalog would make the initial design
doc shape fit the work instead of forcing every slice through one
universal outline.

## Proposed Contract

- Enforcement level:
each template's "Must contain" list defines scaffold prompts and
review expectations, not an immediate hard validator. A design doc
using `contract-surface` or another template SHOULD address those
topics, but authors may merge or omit headings when reviewers accept
the rationale. A later validation slice may choose to turn those
prompts into explicit heading checks once template metadata is stable.
- Shared core across all templates:
all templates keep the current frontmatter contract
(`title`, `legend`, `cycle`, `source_backlog`) plus the shared
sections `## Sponsors`, `## Hill`, `## Playback Questions`,
`## Accessibility and Assistive Reading`,
`## Localization and Directionality`,
`## Agent Inspectability and Explainability`, `## Non-goals`, and
`## Backlog Context`.
- Template identifier:
future scaffolds may add an explicit template marker such as
`template: default-change | contract-surface | refactor-cleanup | docs-policy | spike`.
Historical docs do not need immediate backfill.

## Template Catalog

### `default-change`

- Use when:
the slice introduces or changes user-visible behavior, a workflow, or
a meaningful internal capability with shipped outcomes.
- Must contain:
the intended behavior or contract, the main happy path, expected
failure or edge cases, and a verification plan that proves the slice
actually landed.
Comment thread
flyingrobots marked this conversation as resolved.
- Recommended scaffold sections:
`## Intended Behavior`,
`## Happy Path`,
`## Edge Cases and Failure Modes`,
`## Verification Plan`.
Authors may merge or rename these sections when reviewers accept the
rationale, but the scaffold should present them as the default
structure.
- Optional emphasis:
examples, sequence diagrams, rollout notes, or migration notes when
the change is user-visible.

Comment thread
flyingrobots marked this conversation as resolved.
### `contract-surface`

- Use when:
the slice is mainly about a bounded surface such as CLI flags, MCP
tools, JSON shapes, exit codes, schemas, or generated reference docs.
- Must contain:
an explicit surface inventory, required input and output shapes,
compatibility expectations, failure modes, and concrete examples of
the resulting contract.
- Recommended scaffold sections:
`## Surface Inventory`,
`## Input and Output Contract`,
`## Compatibility Expectations`,
`## Failure Modes`,
`## Examples`.
- Optional emphasis:
deprecation notes, migration windows, or parity requirements across
multiple surfaces such as CLI and MCP.

### `refactor-cleanup`

- Use when:
the main value is structural cleanup, extraction, decomposition, or
removing drift without intentionally changing external behavior.
- Must contain:
the current pain or maintenance risk, the invariants that must remain
true after the refactor, the planned cut boundaries, and the
regression checks that prove the cleanup did not create behavioral
drift.
- Recommended scaffold sections:
`## Current Pain`,
`## Invariants`,
`## Cut Boundaries`,
`## Regression Checks`.
- Optional emphasis:
before/after module maps, ownership boundaries, or dependency
simplification notes.

### `docs-policy`

- Use when:
the slice primarily changes README content, process rules, signposts,
wording policy, or repo-truth coordination docs.
- Must contain:
the affected audiences, the truth sources that must stay aligned, the
semantic wording changes being made, and any regeneration or sync
surfaces that must remain consistent after the edit.
- Recommended scaffold sections:
`## Audience`,
`## Truth Sources`,
`## Wording Changes`,
`## Regeneration and Sync Impact`.
- Optional emphasis:
before/after wording examples, cross-reference tables, or explicit
reader journeys.

### `spike`

- Use when:
the slice is exploratory and the main output is a recommendation,
evidence bundle, or narrowed decision rather than shipped production
behavior.
- Must contain:
the question being investigated, the working hypothesis, the evidence
collection plan, the exit criteria for the spike, and the expected
handoff into a later implementation or backlog decision.
- Recommended scaffold sections:
`## Question`,
`## Working Hypothesis`,
`## Evidence Plan`,
`## Exit Criteria`,
`## Expected Handoff`.
- Optional emphasis:
rejected alternatives, benchmark notes, or criteria that would cancel
the follow-on implementation entirely.

## Selection Rules

- Default selection:
this note does not claim that today's `renderDesignDoc()` scaffold
already satisfies the `default-change` prompts. When template support
lands, the no-template path must either update `renderDesignDoc()` to
emit prompts for intended behavior or contract, main happy path,
expected failures or edge cases, and verification plan, or introduce
a distinct legacy template for the current scaffold instead of
pretending it is already `default-change`.
- Explicit selection:
a future `method pull --template <id>` or interactive scaffolder can
choose a more specific template when the backlog item clearly fits a
template type.
- Authoring guidance:
the selector UX should offer short one-line descriptions for each
template so humans and agents can pick one without reading a long
manual during pull.

## Validation Boundary

- First step:
template support should initially be a scaffold and authoring aid,
not an immediate hard validator.
- Follow-on validation:
once the catalog settles, a later slice can decide whether heading or
frontmatter checks belong in a markdown contract gate or generated
scaffold test.

## Non-goals

- Generate full design-doc prose automatically.
- Force every historical design doc to declare a template immediately.
- Create a large taxonomy of narrow templates that is harder to choose
from than the current scaffold.
Loading
Loading