Every rule, and how hard it binds

31 rules match. Showing 1–25. Clear filters

1. SYN-005 Put conditions before instructions IF an instruction applies only under a condition, THEN state the condition before the imperative ELSE give the action directly. Context default
2. SYN-006 One principal action per procedural step IF a step contains multiple independently verifiable actions, THEN split them into ordered steps ELSE retain a tightly coupled action. Context default
3. STR-007 Section answers one reader question IF a section answers multiple unrelated reader questions, THEN split and label them ELSE retain. Context default
4. 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
5. STR-011 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. Context default
6. STR-016 Provide a long-document summary IF a document is long, high-stakes, or cognitively dense, THEN add an accurate summary and navigation ELSE retain. Context default
7. STR-020 Apply progressive disclosure IF novice and expert readers share a document, THEN put the essential path first and route detail to optional layers ELSE match one depth to the known audience. Heuristic
8. 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
9. 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
10. 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
11. 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
12. 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
13. CLR-016 Match specificity to decision need IF the reader must choose or act, THEN include the distinctions that can change that choice and omit distinctions that cannot ELSE select detail for understanding or experience. Context default
14. CLR-018 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. Hard constraint
15. 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
16. 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
17. 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
18. 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
19. 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
20. 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
21. 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
22. 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
23. TEC-009 Troubleshooting begins with observable symptom IF troubleshooting advice begins with an assumed cause, THEN reframe from the user-observable symptom and branch by tests ELSE retain. Hard constraint
24. TEC-010 Safety warning precedes the hazard IF an action can cause injury, loss, security exposure, or irreversible damage, THEN place a severity-labeled warning before the action and state avoidance ELSE block release. Hard constraint
25. TEC-012 Interface labels match exactly IF documentation names a visible label, command, field, endpoint, or code identifier, THEN match its current spelling and capitalization exactly ELSE flag version mismatch. Hard constraint