Bow Tie Kreative Writing System
Run the engine

Rules / clarity

CLR-018 Hard constraint layer: section

Test instructions by execution

IF content instructs a real task, THEN have a representative reader or test environment execute it and record failures ELSE review semantically.

Why the rule exists

An instruction is usable only if it produces the intended result in practice.

Condition

The rule fires when this evaluates true. Paths marked below must be present in the fact base; the engine reports the rest rather than guessing them.

  • section.topic_type eq "task"

Facts this rule reads

PathSource
section.topic_type You supply it

Then

  1. test — target section
  2. record — target section.test_failures
  3. revise — target section

Else

  1. retain — target current_text, No triggering condition is present.

LAKA

Smallest sufficient intervention
Yes
Primary axes

Sources

  • Principles of plain language — Digital.gov / U.S. General Services Administration link
    Design content so the intended audience can find, understand, and use it.
  • DITA 1.3 Technical Content Specification — OASIS link
    Topic-based concept, task, reference, troubleshooting, and reuse architecture.
  • Technical Writing Process — Kieran Morgan
    A repeatable process for planning and producing documentation.
  • Developing Quality Technical Information — Michelle Carey; Moira Lanyi; Deirdre Longo; et al.
    Quality dimensions for usable technical information.
The raw rule record

Verbatim from 11-clarity-style-rules.json. Also available at /v1/rules/CLR-018.

{
  "id": "CLR-018",
  "name": "Test instructions by execution",
  "domain": "clarity",
  "layer": "section",
  "strength": "hard_constraint",
  "human_logic": "IF content instructs a real task, THEN have a representative reader or test environment execute it and record failures ELSE review semantically.",
  "when": {
    "path": "section.topic_type",
    "operator": "eq",
    "value": "task"
  },
  "then": [
    {
      "action": "test",
      "target": "section",
      "method": "representative_execution"
    },
    {
      "action": "record",
      "target": "section.test_failures"
    },
    {
      "action": "revise",
      "target": "section",
      "from": "observed_failures"
    }
  ],
  "else": [
    {
      "action": "retain",
      "target": "current_text",
      "reason": "No triggering condition is present."
    }
  ],
  "unless": [],
  "because": "An instruction is usable only if it produces the intended result in practice.",
  "diagnostics": [],
  "examples": {},
  "source_ids": [
    "WEB-002",
    "WEB-008",
    "BK-021",
    "BK-024"
  ],
  "laka": {
    "smallest_sufficient_intervention": true,
    "primary_axes": [
      "scope",
      "depth",
      "magnitude",
      "reversibility"
    ]
  }
}

Other clarity rules

  1. CLR-001 Prefer the precise familiar word IF two words are equally accurate AND one is more familiar to the audience, THEN use the familiar word ELSE keep the precision-bearing term. Context default
  2. CLR-002 Define necessary jargon IF a domain term is necessary AND the intended reader may not know it, THEN define it at first use and use it consistently ELSE replace it with plain language. Context default
  3. CLR-003 Expand unfamiliar abbreviations IF an abbreviation is not universally familiar to the audience, THEN spell it out at first use and pair it with the abbreviation ELSE retain. Context default
  4. CLR-004 One term per concept IF multiple terms refer to the same technical concept without rhetorical need, THEN select one preferred term and replace the variants ELSE retain. Context default
  5. CLR-005 One concept per term IF the same term denotes multiple concepts in one context, THEN rename or qualify the concepts ELSE retain. Hard constraint
  6. CLR-006 Replace vague reference words IF THIS, THAT, IT, THEY, FORMER, or LATTER has an uncertain referent, THEN repeat or summarize the referent ELSE retain. Hard constraint
  7. CLR-007 Quantify actionable vagueness IF vague quantity, frequency, time, or probability affects a decision, THEN provide a range, threshold, date, or defined category ELSE retain approximate language. Context default
  8. CLR-008 Use concrete examples after abstractions IF a central abstraction lacks a concrete instance AND the audience knowledge gap is moderate or large, THEN add one representative example ELSE retain. Heuristic