Chapter 8

The Rhetorical Situation

Instructions are shaped by:

  • Audience: Define primary (and secondary) users; tailor content to their needs.

  • Purpose: Guide users through steps to complete a task; may include troubleshooting, teaching subtasks, or defining terms.

  • Context: Time constraints, urgency, technology, tool/material availability, cultural factors.

Planning & Shaping Instructions

Procedure vs Task vs Step:

  • Procedure: Entire set of actions (e.g., “Make spaghetti and meatballs”).

  • Task: Semi-independent group of steps (e.g., prepare meatballs, boil pasta).

  • Step: Individual actions within tasks.

Phases: Subgroups of steps inside a task; useful for complex steps.
Grouping Tasks: Improves readability (e.g., unpacking, setup, operating, maintenance, troubleshooting).

Content Structure

Standard Sections:

  • Front Matter: Title, contents (for complex manuals).

  • Introduction/Opening: Purpose, audience, materials, precautions, estimated time, motivation.

  • Procedure/Body: Numbered steps, divided into tasks/phases.

  • Conclusion/Closing: Completion signal, benefits, next steps, troubleshooting, tips, specs.

  • Back Matter: Appendices, FAQs, product specs.

Introduction/Opening Includes:

  • Clear title

  • Goal/purpose verbs: instruct, guide, train

  • Audience and required skills

  • When to use instructions

  • Overview and motivation

  • Time estimate

Precautionary Statements / Warnings

  • Alert users to damage, injury, or death risks

  • Must use proper labeling (Notice, Caution, Warning, Danger)

  • Place at the beginning and before hazardous steps

  • Notices/tips go after steps for clarification

  • Balance warning frequency to avoid overuse or underuse

Technical Background & Materials

  • Provide the necessary theory if required

  • List tools, equipment, and supplies clearly

  • Indicate sources if needed

Step-by-Step Instructions

Types of Steps:

  • Fixed-order: Numbered sequentially

  • Variable-order: Bulleted; flexible order

  • Alternate: Multiple options; “OR” bullets

  • Nested: Complex steps broken into sub-steps

Supplementary Discussion:

  • Add clarifying notes or tips

  • Bold main actions for emphasis

Language & Style:

  • Imperative mood: “Press the button”

  • Active voice, concise, plain language

  • Avoid slang/metaphors/jargon unless defined

  • Define acronyms/technical terms

  • Use clear headings/subheadings

Consistency & Parallelism:

  • Steps follow same grammatical format

  • Avoid confusing synonyms

Conclusions/Closing Sections

  • Signal completion, restate benefits

  • Include optional info: cleanup, maintenance, FAQ, troubleshooting, tips, product specs, sources

Graphics (Notes Only)

  • Crucial for visualizing steps

  • Refer to graphics in text (label: Figure 1, 2, …)

  • If drawing or photos aren’t feasible, use smartphones or simple diagrams

  • Avoid copying images from the internet for ethical reasons

Document Design Principles

Definition: How information is organized and visually presented.

  • Users notice design before content

  • Make the document scannable, clear, and audience-focused

Key Elements:

  • Consistency/Repetition: Uniform fonts, headings, layout

  • Contrast: Highlight key info; works best with consistent design

  • Alignment: Horizontal/vertical organization creates hierarchy

  • Balance: Even distribution of visual weight

  • White Space: Separates items and groups, improves readability

  • Grouping/Proximity: Keep related items/images close

  • Color: Use consistently for contrast/emphasis with graphics

Headings & Lists:

  • Headings for sections/subsections; improves navigation

  • Numbered vertical lists = steps

  • Simple/two-column lists = materials

  • In-sentence lists = overviews

Numbers, Abbreviations, Symbols: Follow style guides for clarity