Bow Tie Kreative Writing System

Rules / technical writing

TEC-011 Context default layer: sentence

UI verb works across input methods

IF an instruction refers to a generic interface action, THEN prefer input-neutral verbs such as SELECT, OPEN, ENTER, or CHOOSE; use CLICK only for mouse-specific action ELSE retain.

Why the rule exists

Input-neutral language supports touch, keyboard, voice, assistive technology, and mouse use.

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.

  • sentence.ui_action eq true

Facts this rule reads

Fact paths read by TEC-011 and whether the analyser derives them
PathSource
sentence.ui_action You supply it

Then

  1. select — target sentence.action_verb

Else

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

Test cases

TST-015 · [object Object]

Before
Click Save.
After
Select Save.
Reason
The instruction works across input methods.

LAKA

Smallest sufficient intervention
Yes
Primary axes

Sources

  • Microsoft Writing Style Guide — Microsoft link
    Warm, clear, concise, helpful technical communication.
  • Writing for Web Accessibility — W3C Web Accessibility Initiative link
    Clear structure, descriptive labels, alternatives, and understandable content.
The raw rule record

Verbatim from 15-technical-writing-rules.json. Also available at /v1/rules/TEC-011.

{
  "id": "TEC-011",
  "name": "UI verb works across input methods",
  "domain": "technical_writing",
  "layer": "sentence",
  "strength": "context_default",
  "human_logic": "IF an instruction refers to a generic interface action, THEN prefer input-neutral verbs such as SELECT, OPEN, ENTER, or CHOOSE; use CLICK only for mouse-specific action ELSE retain.",
  "when": {
    "path": "sentence.ui_action",
    "operator": "eq",
    "value": true
  },
  "then": [
    {
      "action": "select",
      "target": "sentence.action_verb",
      "by": "input_method",
      "default": "input_neutral"
    }
  ],
  "else": [
    {
      "action": "retain",
      "target": "current_text",
      "reason": "No triggering condition is present."
    }
  ],
  "unless": [],
  "because": "Input-neutral language supports touch, keyboard, voice, assistive technology, and mouse use.",
  "diagnostics": [],
  "examples": {},
  "source_ids": [
    "WEB-004",
    "WEB-005"
  ],
  "laka": {
    "smallest_sufficient_intervention": true,
    "primary_axes": [
      "scope",
      "depth",
      "magnitude",
      "reversibility"
    ]
  }
}

Other technical writing rules

  1. TEC-001 Choose an information type IF a technical topic is being created, THEN classify it as concept, task, reference, troubleshooting, glossary, or mixed with explicit boundaries ELSE do not draft a generic blob. Hard constraint
  2. TEC-002 Concept answers what and why IF the reader asks what something is or why it matters, THEN use a concept topic with definition, model, relationship, boundary, and example ELSE select another type. Context default
  3. TEC-003 Task answers how to achieve a goal IF the reader wants to achieve an outcome, THEN use a task topic with goal, prerequisites, steps, results, recovery, and verification ELSE select another type. Context default
  4. TEC-004 Reference supports lookup IF the reader needs facts about an entity or interface, THEN use stable repeated fields, valid values, defaults, constraints, examples, and links ELSE select another type. Context default
  5. TEC-005 Prerequisites before steps IF a task requires permissions, state, tools, knowledge, inputs, or safety conditions, THEN list them before step 1 ELSE state that none are required only when useful. Hard constraint
  6. TEC-006 Imperative starts the step IF the reader performs a procedural action, THEN start with a specific imperative verb and name the object ELSE name the actual actor. Context default
  7. TEC-007 Expected result follows uncertain action IF a step’s success is not self-evident, THEN state the observable result immediately after it ELSE retain. Context default
  8. TEC-008 Recovery follows known failure IF a step has a common or consequential failure mode, THEN provide symptom, cause or check, corrective action, and verification ELSE retain. Context default