Examples of Technical Writing: 7 Annotated Samples

November 11, 2026 · 12 min read

Examples of Technical Writing: 7 Annotated Samples You Can Copy

The most useful examples of technical writing are short documents that help one reader finish one task. Think of a step list, a quick start, a troubleshooting page or an error message. Below are seven annotated samples, each written in Markdown, so you can copy one, rewrite it for your own product and export it as a portfolio piece.

What Counts as an Example of Technical Writing?

Technical writing is any document that explains how something works or how to use it, written for a reader who needs to act on it. You meet it every day: the setup card in an appliance box, the method section of a recipe, the dialog that says why a file won't save.

The samples below use a made-up product called Acme, so swap in your own names and commands before you run anything. Here's what each one is for:

SampleDocument typeReaderJob it does
1Step-by-step instructionsA user mid-taskComplete one task safely
2Quick-start guideA new userReach a first success fast
3Troubleshooting articleA stuck userMatch a symptom to a fix
4Error messages and microcopyAnyone in the UIRecover without leaving the screen
5Reference entryA user who knows the basicsLook up one exact value
6White paper excerptA decision makerWeigh evidence for a choice
7Changelog and procedureUsers and teammatesRecord what changed, repeat a routine

These map loosely onto the Diátaxis split of tutorials, how-to guides, reference and explanation. Every sample is plain Markdown. If you're still learning the syntax, our sample Markdown file shows every common element in one place.

One limitation up front: Markdown suits text-first docs, but it doesn't show layout-heavy print manuals or annotated screenshots well. If your sample depends on callouts drawn over images, you'll need a design tool as well. For layout-heavy manuals, our technical writing software comparison covers tools built for print, such as FrameMaker.

Sample 1: Step-by-Step Instructions for a Single Task

Instructions are the form most people picture first. If you want a technical writing example for instructions, this is the pattern to copy: a goal in the heading, prerequisites, numbered steps and a result you can check.

## Restore a note from a backup

Use a backup file to bring back notes you deleted or overwrote.

**Before you start:** You need a backup file (.acmebak) and the desktop app open.

**Warning:** Restoring replaces every note in the current notebook. Export the notebook first if you want to keep its contents.

1. Select **File > Restore from backup**.
2. Choose the .acmebak file, then select **Open**.
3. Select **Restore**. The notebook reloads and shows the notes from the backup.

That renders as an H2, a one-line intro, two paragraphs with bold labels and a three-item numbered list. Why it works:

  • The warning comes before the risky step, not after it. Readers act as they read.
  • Each step starts with a verb and names the exact control. Google's guidance on procedures asks for an imperative verb in every step, with the action first and its result in the same paragraph.
  • Step 3 tells you what success looks like, so you know you're done.

Here's the same step written weakly, then rewritten:

Weak:   3. The restore process can then be initiated, after which the notes should be restored.
Strong: 3. Select **Restore**. The notebook reloads and shows the notes from the backup.

The weak version hides the action in passive voice and never names the button.

Sample 2: A Quick-Start Guide That Ends in One Success

A quick start has one job: get a new user from zero to a working result in a few minutes. It picks one path and leaves the alternatives for later pages.

## Quick start

You need Node.js 20 or later. Setup takes about two minutes.

**1. Install the CLI**

```bash
npm install -g acme-docs-cli
```

**2. Create and serve a site**

```bash
acme init my-site
cd my-site
acme serve
```

You should see `Serving my-site at http://localhost:4000`. Open that address to view your site.

Next: [Add your first page](add-a-page.md)

The sample states its prerequisite and its time cost in its opening sentence. It shows the exact output to expect, so the reader can confirm success without guessing. It ends with one next step, not a menu of ten.

Quick starts usually live in a README. For the rest of that file's structure, see our README Markdown guide.

Sample 3: A Troubleshooting Article Built on Symptom, Cause, Fix

Troubleshooting pages get read by someone who's already frustrated. The structure that works is symptom, cause, fix, with the exact error text in the title so search finds it.

The sample below is live. Edit the Markdown and the preview updates as you type, so you can turn it into your own article and export it.

Sync fails with error 401

Applies to: desktop app 4.x

Symptom

Sync stops and the status bar shows Error 401: token expired.

Cause

Your sign-in token expired after a password change.

Fix

  1. Open Settings, then Account.
  2. Select Sign out.
  3. Sign in again with your new password.
  4. Select Sync now. The status bar shows Up to date.
If you see Do this
Error 403 Ask your admin for access
Error 500 Wait 5 minutes and retry
93 words468 characters19 lines
Markdown

What makes it work:

  • The title names the error code users actually see, so a search for that code lands here.
  • The Applies to line stops readers on the wrong version from following steps that don't fit.
  • The cause is one sentence. Readers want the fix, but the cause tells them it won't happen again by accident.
  • The table handles near-misses, so a reader with a 403 doesn't leave empty-handed.

When you're happy with your version, open the Download/Export menu and pick Export as PDF. The export runs on the server, so it counts toward the free daily pool. The Markdown to PDF converter does the same job on its own page and produces an A4 PDF.

Sample 4: Error Messages and UI Microcopy, Before and After

The shortest technical writing examples sit inside the product: error messages, button labels, empty states. Nielsen Norman Group's error message guidelines cover visibility and placement as well as wording. The wording advice comes down to three things: say what went wrong in plain words, offer a fix, and don't blame the user. They even flag words like invalid and illegal as blaming.

ElementBeforeAfter
ErrorAn error occurred.We couldn't save your note because you're offline. Your changes stay on this device until you reconnect.
Form validationInvalid input.Enter the date as YYYY-MM-DD, for example 2026-11-11.
ButtonSubmitCreate project
Empty stateNo items.No notes yet. Select New note to write your first one.

Each rewrite answers the question the reader is silently asking. The error says what happened and that nothing's lost. The validation message shows a valid value instead of describing the rule. The button names the outcome, and the empty state points to the next action.

Microcopy rarely makes a long portfolio piece on its own. A before-and-after table like this one, with a sentence on each change, shows editing judgment in very little space.

Sample 5: A Reference Entry for One Config Option

Reference docs are for looking things up, not for reading top to bottom. Every entry follows the same shape, so a reader who's seen one can scan the rest.

### sync.interval

How often, in seconds, the app checks the server for changes.

| Property | Value |
|---|---|
| Type | Integer |
| Default | 300 |
| Allowed range | 30 to 3600 |
| Requires restart | No |

```toml
[sync]
interval = 600
```

Lower values sync sooner but use more battery on laptops.

That renders as an H3, a one-line definition, a two-column table, a code block and one sentence of advice. The table answers the four questions people actually look up, and the example shows the syntax in context. The final line adds the trade-off that a bare table can't express.

A full API reference, with endpoints, requests and responses, is a much bigger job than one entry. Keep this sample to a single option or command. To see full references done well, our examples of API documentation walk through Stripe, GitHub and Twilio.

Sample 6: A White Paper Excerpt That Argues From Evidence

White papers and recommendation reports argue for a decision, and they do it with evidence instead of adjectives. The pattern is claim, support, recommendation.

## Why we recommend moving sync to a 5-minute interval

Frequent sync is expensive for us and for users. In Q3, the 60-second
interval accounted for 41% of server load while 88% of sync checks
found no changes.

A 5-minute interval cuts those empty checks by roughly 80%. In a
four-week trial with 1,200 users, support tickets about stale notes
rose by 3, from 14 to 17. Battery complaints on laptops fell from 22 to 9.

We recommend making 300 seconds the default in version 2.4 and keeping
60 seconds available as an opt-in setting.

The numbers in this sample are placeholders, so in a real report each figure would cite its source. Notice the first sentence of each paragraph carries the point, and the rest supports it. There's no "industry-leading" or "best-in-class" anywhere. The recommendation names a version and a fallback, which gives a reader something concrete to approve or reject.

Sample 7: A Changelog Entry and an Internal Procedure in Brief

Two small forms finish the gallery. A changelog entry tells users what changed in a release, grouped by type. The Keep a Changelog convention puts the latest version first, dates it and groups changes under headings such as Added, Changed and Fixed.

## [2.4.0] - 2026-10-02

### Changed
- The default sync interval is now 300 seconds (was 60).

### Fixed
- Sync no longer stops after you change your password.

An internal procedure does the same for a team routine. Name the owner and the frequency, then keep it to steps.

**Rotate the staging API key** (monthly, owner: platform team)

1. In the secrets manager, create a key named staging-api-YYYY-MM.
2. Update STAGING_API_KEY in the CI settings and rerun the deploy.
3. Delete the old key after the deploy passes.

Both entries are written for someone scanning, which is why each line starts with the thing that changed or the action to take. For complete files you can start from, see our Markdown templates. For changelogs in depth, our changelog example annotates a full CHANGELOG.md file.

What Are Good Examples of Technical Writing Samples for a Job?

Hiring managers want to see how you think about a reader, not how much you can write. Pick one or two forms from this gallery and keep each to one or two pages. Add a short note on who the reader is and what they need to do.

We prefer a rewrite of a real, messy document over a piece written from scratch. Show the before state, then your version, then three or four lines on what you changed and why. That's the same before-and-after move as Samples 1 and 4, and it proves editing skill that a polished original can't. Pick public material, such as an open-source project's docs, so you aren't sharing anything confidential.

For students, the best sample technical writing is a quick start or a troubleshooting article for software you already use. Both are short, both have a clear success test, and a reviewer can check them in a few minutes. If you want to write the whole portfolio as docs-as-code, our guide to writing documentation in Markdown covers the setup.

To turn a sample into a PDF, paste it into the editor, open the Download/Export menu and choose Export as PDF. Free users can export documents up to 5,000 characters this way, and server-side exports share a free pool of 3 a day. Download .md stays unlimited, so keep the source file either way.

Good examples of technical writing share the same habits: one reader, one task, an action-first step and a result you can check. Copy whichever sample matches the document you need, replace Acme with your own product, and test every step yourself before anyone else reads it. Open the editor to draft yours with a live preview, then download the .md file or export it as a PDF.