Skip to content

Feature-level workflow

Product capability: the feature-level workflow of the merlon-docs skill implements and documents shipped features using a docs-first then TDD loop so Merlon Docs shards stay the contract before product code changes.

Workflow file: skills/merlon-docs/references/workflows/feature-level.md. Skill workflows covers the shared workflow contract: intake, atomic commit groups, guide placement, the glossary, and concept removal.

Shipped capabilities are documented for consumers and contributors before code lands. Acceptance criteria in shards stay aligned with as-built behavior instead of drifting in chat-only designs.

Obligation As-built expectation
One focused branch Branch for one issue from the updated integration branch; do not mix unrelated features
Place by audience User-facing work → docs/features/ + docs/client/; maintainer-only → docs/developer/ only
Docs first Update guide shards and indexes before product code; put contracts in shards, not code dumps
TDD when code changes Write failing tests first where the repo uses tests, then implement, then refactor; skip TDD when docs-only
Current docs only Align shards to as-built behavior; no superseded-workflow archaeology in durable docs
Validate and wrap-up Run repo tests + merlon check; changeset/release notes per repo conventions; link WORK_ITEM

Required intake says where the integration branch is named.

  • Docs-only technical writing with no product code — prefer the doc-only workflow when the ask is shards-only.
  • Architecture intent / ADR drafting without implementation — use the design-architecture workflow.
  • Primary client-guide UX / journey design — use the ux workflow.
  • Bootstrapping Merlon Docs in an empty or legacy repo — use the getting-started workflow.
  • Expanding beyond the loaded WORK_ITEM — stay on acceptance criteria unless the issue explicitly expands scope.

When the user asks for design-only or docs-only work, this workflow SHOULD defer or narrow to the matching workflow rather than inventing end-to-end delivery.

A successful feature-level session typically:

  1. Updates the correct guide tiers for the audience (features+client or developer)
  2. Writes any product code against the documented acceptance (TDD where applicable)
  3. Leaves durable shards describing current behavior only
  4. Passes repo tests and docs validation
  5. Links WORK_ITEM in review; adds a changeset when published package behavior changes

Optional local with/without-skill grading for this workflow: feature-level workflow live evals (maintainer workflow — not a CI gate). See Live skill evals.