Skip to content

/edikt:guideline:review

Review guideline language quality — checks whether team standards are specific, actionable, and written for consistent enforcement.

This is a scoped shortcut for running /edikt:gov:review targeting guidelines only.

Usage

bash
/edikt:guideline:review
/edikt:guideline:review guideline-api-response-casing

Arguments

ArgumentDescription
(none)Review all guidelines in docs/guidelines/
A guideline slug or filenameReview a specific guideline

What it checks

Each guideline directive is scored on four dimensions:

DimensionStrongVague
SpecificityNames exact patterns, formats, or locationsCould mean anything to different readers
ActionabilityOne clear action, no ambiguityNo actionable instruction
PhrasingActive voice with clear scopePassive or hedged language
TestabilityVerifiable by code review or toolingCannot be verified

Sidecar Cross-Check (v0.6.0)

After the prose-quality review, :review cross-checks the guideline's <guideline>.edikt.yaml sidecar against the prose body for drift. The check is read-only — it never modifies files.

For each directive in the sidecar:

  1. Read <guideline>.edikt.yaml. If missing, warn: "No sidecar found — run /edikt:guideline:compile <slug> to generate."
  2. Locate each of the directive's source_excerpts[].quote entries in the prose body. If any verbatim quote is not found, flag the directive as stale.
  3. Scan the prose body for MUST/NEVER bullets not represented in the sidecar. Flag any extras.

Output is either ✓ Sidecar in sync or a warning list with line numbers. :review never auto-regenerates — the user resolves drift via :compile or by editing the prose.

When to run

  • After writing a new guideline, before it's compiled
  • Periodically — guidelines can accumulate vague language over time

What's next

Released under the Elastic License 2.0. Free to use, not for resale.