How to Write Clear Step-by-Step Instructions for Software
Write software instructions with one action per step, exact interface labels, visible checkpoints, useful screenshots, and concise error routes.
4 min readWorkflowsBy Temposhot Team
Clear software instructions let a reader finish a task without thinking about the instructions. Every extra word, vague label or combined step makes them stop and reread.
This post covers the writing rules that matter most, with examples, and how they apply when you build a guide in Temposhot on a Mac.
Define one finished result
Write the result first, as one sentence the reader can check: "The invoice is sent to the customer and marked Sent." That sentence becomes the title and the last step.
If you cannot write one result, the instructions cover more than one task. Split them. A reader searching for "send an invoice" does not want to scroll past "create a customer".
Start each step with the action
Readers scan for the verb. Put it first.
| Weak | Clear |
|---|---|
| The Settings menu should now be opened. | Open Settings. |
| Next, you will want to click on Save. | Select Save. |
| In the top-right corner there is a Share button. | Select Share in the top-right corner. |
| Make sure that notifications are turned off. | Turn off Notifications. |
Keep a short verb list and use it consistently: Open, Select, Choose, Enter, Turn on, Turn off, Drag. "Click" works for mouse users but fails for keyboard and touch users, so many style guides prefer "Select".
Use exact interface labels
Copy labels exactly as the interface shows them, including capitalization and punctuation. If the button says Add member, do not write "Add a user". Readers match the words on screen.
Bold the label so it stands out from the sentence. Name the location only when the label is hard to find or appears twice: "Select Export in the toolbar, not in the File menu."
Keep one decision per step
A step should contain one action or one choice. "Open Settings, select Billing, and change the plan" is three steps. When the reader looks back at the screen, they lose their place in a long sentence.
Exception: two actions in the same small area that always go together, such as "Enter the code and select Verify". Even then, split them if the second action has a condition.
Add checkpoints after important actions
After an action that changes something, tell the reader what they should see: "A green banner shows Changes saved." Checkpoints confirm progress and catch errors early, before the reader is five steps further.
Put checkpoints after saves, submits, imports, permission prompts and anything that takes time to load.
Write branches from observable conditions
Branches are where readers get lost. Base them on something the reader can see, not on something they must know.
- Weak: "If you are on the legacy plan, ..."
- Clear: "If the page shows Upgrade to continue, go to step 7."
Keep branches short. If a branch has more than two steps, move it into its own guide and link to it.
Let screenshots show location and state
Text says what to do. A screenshot shows where and what it looks like. Use one per step, cropped to the area that matters, with one mark on the target. A screenshot also confirms state: the reader compares their screen and knows they are on track.
Temposhot builds that pairing from your clicks. Open Action Capture (Command+3), turn on Parse clicked elements under Configure, and select Start Action Capture. Each accepted click saves the screen just before the click, with a draft title such as Click "[[element-name]]". After Finish capture, the Document opens in the editor.
Rewrite each draft title using the rules above, for example Click "Save" to "Select Save to keep the changes". Put checkpoints and conditions in the Page description. In a PDF export, descriptions can appear before or after each screenshot (a Pro customization). The editor guide covers titles, descriptions and tools.
Remove filler and hidden assumptions
Cut words that do not change what the reader does:
- "Simply", "just", "easily": they add nothing and make struggling readers feel worse.
- "You will now want to", "Go ahead and": start with the verb instead.
- "As mentioned above": repeat the fact or link to it.
Then look for assumptions. Does the reader know where the app is, which account to use, what a term means? Add one line for each gap, usually in the prerequisites.
Test the instructions without explaining them
Give the instructions to someone who has not done the task. Watch them follow it, and do not answer questions. Each pause or question points to a step that needs a clearer action, label or checkpoint.
Fix those steps and test again with a different person if you can. Two clean runs are a good sign the instructions work. The screenshot tutorial checklist lists the remaining checks before you publish.
Frequently Asked Questions
Should I use "click" or "select" in instructions?
"Select" works for mouse, keyboard and touch. Use "click" only if your audience uses a mouse and your style guide prefers it. Whichever you choose, use it consistently.
How long should one step be?
One sentence for the action, plus an optional sentence for the result or condition. Longer explanations belong in a note or a separate page.
Do instructions need numbered steps?
Yes, when the order matters. Numbers let readers keep their place and let support refer to "step 4". Temposhot's PDF export can add step numbers (Pro).
Where do warnings go?
Before the step they apply to. A warning after a destructive action arrives too late.
Turn your clicks into a clear step-by-step guide
Action Capture gives you one screenshot and one draft title per click, ready for these writing rules. Download Temposhot and write your next guide on top of a recording.
technical-writinginstructionsstep-by-stepdocumentation
Terms used here: visual documentation
Turn repeatable screenshots into finished work
Temposhot captures on a timer or on every click and exports the result as a PDF, images, ZIP or MP4.
Related posts
- How to Annotate Screenshots for Clear Instructions on MacUse click markers, arrows, shapes, text, crop, and blur to make instructional screenshots clear without covering important context.
- How to Create an SOP with ScreenshotsCreate a visual SOP with a defined scope, owner, prerequisites, step-by-step screenshots, exceptions, checks, and a review date.
- How to Create a Step-by-Step Guide from Clicks on MacCreate a step-by-step guide on Mac by capturing meaningful clicks, marking each action, editing the steps, and exporting images or a PDF.
- Best Xnapper Alternatives for Mac in 2026Compare Xnapper alternatives for Mac: repeated capture, scrolling capture and recording, free backgrounds, cross-platform guides, and the built-in app.