Rules / structure

Order by reader task

IF the document supports an action, THEN order information by the reader’s task rather than the organization’s internal structure ELSE select chronological, causal, spatial, or importance order.

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.

Facts this rule reads

LAKA

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.
• The Insider's Guide to Technical Writing — Krista Van Laan
  Documentation practice, careers, projects, and users.
• Developing Quality Technical Information — Michelle Carey; Moira Lanyi; Deirdre Longo; et al.
  Quality dimensions for usable technical information.

{
  "id": "STR-011",
  "name": "Order by reader task",
  "domain": "structure",
  "layer": "document",
  "strength": "context_default",
  "human_logic": "IF the document supports an action, THEN order information by the reader’s task rather than the organization’s internal structure ELSE select chronological, causal, spatial, or importance order.",
  "when": {
    "path": "document.supports_reader_action",
    "operator": "eq",
    "value": true
  },
  "then": [
    {
      "action": "reorder",
      "target": "document.sections",
      "by": "reader_task_sequence"
    }
  ],
  "else": [
    {
      "action": "select",
      "target": "document.organizing_principle",
      "options": [
        "chronology",
        "causality",
        "space",
        "importance",
        "comparison"
      ]
    }
  ],
  "unless": [],
  "because": "Reader-centered order makes information usable.",
  "diagnostics": [],
  "examples": {},
  "source_ids": [
    "WEB-002",
    "WEB-008",
    "BK-020",
    "BK-024"
  ],
  "laka": {
    "smallest_sufficient_intervention": true,
    "primary_axes": [
      "scope",
      "depth",
      "magnitude",
      "reversibility"
    ]
  }
}

Other structure rules

1. STR-001 One controlling move per paragraph IF a paragraph performs more than one unrelated rhetorical move, THEN split it at the move boundary ELSE retain. Context default
2. STR-002 Expose the paragraph point IF the paragraph’s controlling point is absent or recoverable only after rereading, THEN state or move it to a strategic position ELSE retain an intentional delayed reveal. Heuristic
3. STR-003 Support consequential claims IF a paragraph makes a consequential factual claim, THEN provide evidence, cite it, qualify it, or remove the claim ELSE retain. Hard constraint
4. STR-004 Keep evidence beside the claim IF evidence is separated from the claim it supports by unrelated material, THEN move it closer or label the relation ELSE retain. Context default
5. STR-005 Use transitions that name the relation IF adjacent paragraphs have a meaningful but unstated relation, THEN add a transition that expresses that relation ELSE retain. Context default
6. STR-006 Delete orphan paragraphs IF a paragraph neither advances the purpose nor supports another necessary move, THEN delete or relocate it ELSE retain. Heuristic
7. STR-007 Section answers one reader question IF a section answers multiple unrelated reader questions, THEN split and label them ELSE retain. Context default
8. STR-008 Heading predicts content IF a heading does not accurately predict its section, THEN rename the heading or repair the section ELSE retain. Hard constraint