Bow Tie Kreative Writing System
Run the engine

Rules / clarity

CLR-004 Context default layer: document

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.

Why the rule exists

Terminology variation can look like conceptual variation in technical and translated content.

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.

  • ALL
    • concept.label_count gt 1
    • concept.synonym_variation_needed eq false

Facts this rule reads

PathSource
concept.label_count You supply it
concept.synonym_variation_needed You supply it

Then

  1. normalize — target concept.labels, value from terminology.preferred_term

Else

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

LAKA

Smallest sufficient intervention
Yes
Primary axes

Sources

  • Microsoft Writing Style Guide — Microsoft link
    Warm, clear, concise, helpful technical communication.
  • Developing Quality Technical Information — Michelle Carey; Moira Lanyi; Deirdre Longo; et al.
    Quality dimensions for usable technical information.
  • Handbook of Technical Writing — Gerald J. Alred; Charles T. Brusaw; Walter E. Oliu
    Grammar, mechanics, formats, and workplace documents.
The raw rule record

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

{
  "id": "CLR-004",
  "name": "One term per concept",
  "domain": "clarity",
  "layer": "document",
  "strength": "context_default",
  "human_logic": "IF multiple terms refer to the same technical concept without rhetorical need, THEN select one preferred term and replace the variants ELSE retain.",
  "when": {
    "all": [
      {
        "path": "concept.label_count",
        "operator": "gt",
        "value": 1
      },
      {
        "path": "concept.synonym_variation_needed",
        "operator": "eq",
        "value": false
      }
    ]
  },
  "then": [
    {
      "action": "normalize",
      "target": "concept.labels",
      "value_from": "terminology.preferred_term"
    }
  ],
  "else": [
    {
      "action": "retain",
      "target": "current_text",
      "reason": "No triggering condition is present."
    }
  ],
  "unless": [],
  "because": "Terminology variation can look like conceptual variation in technical and translated content.",
  "diagnostics": [],
  "examples": {},
  "source_ids": [
    "WEB-004",
    "BK-024",
    "BK-025"
  ],
  "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-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
  5. 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
  6. 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
  7. 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
  8. CLR-009 State implied steps for novice readers IF success requires an unstated inference that a novice may not make, THEN state the step or prerequisite ELSE retain expert compression. Context default