hermes

Write a user manual

Writes a task-based user manual for a physical product, appliance, office system or service, with safety notices, setup, everyday tasks, care and troubleshooting organised by symptom.

context

People open a manual when they are trying to do something or something has gone wrong, not to read about features. Task-based manuals (the minimalist approach from technical communication research) organise content around what users want to do, start each task with the action, put one action in each step, show what should happen after a step, and let readers recover from errors. Manuals fail when they describe each button in turn, bury safety warnings in the middle of steps, use names that differ from the labels on the product, assume knowledge the reader lacks, or invent specifications the product does not have.

Safety notices follow the widely used signal-word hierarchy: DANGER (will cause death or serious injury), WARNING (could cause death or serious injury), CAUTION (could cause minor or moderate injury), NOTICE (property damage only, no injury). Each notice names the hazard, the consequence and how to avoid it, and sits before the step it applies to.

task

Write a user manual for a reader.

product description

Only if [KNOWN_ISSUES] is given:

known issues

  1. If you cannot tell what the product is, what its main controls are, or how it is used, ask for those details and stop.
  2. List the user's tasks in the order they meet them: unpacking and checking the contents, setup, first use, everyday tasks, occasional tasks (settings, cleaning, refilling, replacing parts), and end of life (storage, disposal) where relevant.
  3. Write each task as: a heading that names the goal ("Make a double espresso", "Add a new user"), any prerequisite, safety notices that apply, then numbered steps. One action per step, imperative mood, the control named exactly as labelled and in bold, and the expected result in italics after the steps where users need confirmation.
  4. Pitch the detail to : novices get every step and a one-line explanation of unfamiliar terms; regular users get compact steps; experts get reference tables and shortcuts.
  5. Write troubleshooting as a table organised by what the user notices (the symptom), not by internal cause: Symptom · Possible cause · What to do. Use known issues first, then obvious checks (power, connection, consumables). Escalation to support or a qualified technician goes last.
  6. Add safety notices only for hazards that follow from the description (heat, electricity, moving parts, pressure, chemicals, weight, children, data loss) and mark any you inferred with [confirm].
  7. Keep a list of every fact you needed but did not have (dimensions, voltages, capacities, button names, temperatures, warranty terms, support contacts) and use [confirm: …] in the text rather than inventing them.
constraints
  • Never invent specifications, settings, part numbers, certifications, warranty terms or contact details.
  • Use the product's own names for controls and screens consistently; if the description uses two names for one thing, pick one and note it.
  • Plain language: short sentences, active voice, second person, no marketing claims.
  • For electrical, gas, pressure, children's, medical or vehicle products, note under Facts to confirm that legally required manual content and safety wording differ by market and must be checked against the applicable regulations before publication.
  • Keep each task under about ten steps; split longer ones.
output format

Manual

Title, then: Safety information · What is in the box (or What you need) · Parts and controls (table: Part · What it does) · Setup · Everyday tasks · Occasional tasks · Care and maintenance · Troubleshooting (table) · Specifications (only supplied facts) · Getting help.

Facts to confirm

Bullets: every [confirm: …] placeholder and inferred safety notice, grouped by section, plus any naming inconsistencies found.

1 required value still a placeholder; the assistant will ask for it.

details

kind
Prompt: a task you run by name to get one finished thing back
domain
Writing and communication
category
Business writing
level
Intermediate
depth
Specific
made for
Technical writer, Founder / business owner, Operations, Product manager
risk
read-only
version
v1.0.0 · incubating
reviewed
2026-10-03
works in
Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Antigravity, OpenCode, Windsurf, Zed, Continue, AGENTS.md, ChatGPT, claude.ai

Edit on GitHubReport a problem

use in

Hodios CLI
npx @hermes-hq/hodios install write-user-manual --target claude-code
Agent Skills
npx skills add hermes-hq/hodios-dist --skill write-user-manual -a claude-code
Add the Hodios marketplace (once)
claude plugin marketplace add hermes-hq/hodios-dist
Install the writing-communication plugin
claude plugin install hodios-writing-communication@hodios

The plugin brings every entry in this domain at once.

PromptOperations

Write a standard operating procedure

Writes a standard operating procedure from a process description - purpose, scope, roles, numbered steps, checks and exceptions - with gaps flagged for confirmation. Use to document a repeatable task.

write-sop
PromptEditing

Simplify a text to plain language

Rewrites a text in plain language at a target reading level while keeping every fact, obligation, right, deadline and condition intact, and shows a meaning check against the original.

simplify-to-plain-language
PromptEditing

Review a document for ambiguity

Finds statements in instructions, policies, requirements or agreements that readers could interpret two ways, explains each reading and its consequence, and proposes unambiguous wording.

review-document-for-ambiguity
PromptBusiness writing

Write a work document

Drafts a memo, report, proposal, update or announcement from your notes, picking the right type for the reader and leading with the point and the ask. Use when you need to write something at work.

write-work-document
PromptBusiness writing

Write an award nomination

Writes an award or recognition nomination that maps a colleague's specific achievements and evidence to each published criterion, within the word limit, and shows where the case is weak.

write-award-nomination
PromptBusiness writing

Write a formal letter

Writes a formal letter to a bank, council, school, supplier or official body in the layout and conventions of the chosen country, with a clear purpose, references and a specific request.

write-formal-letter