TechDemo

Short description to complement the title, used in navigation and search results; helps user decide whether this is the topic they need. Scope statement here or in Context?

Scope statements improve search results and tell readers what to expect. They help readers determine whether an article will be useful. Sometimes, scope statements help people who don’t need the article than they help people who do! For example, if an article about TipTicket bill code reports begins with a scope statement that says the article is about Tip Ticket, then a reader who’s looking for help with bill codes in Trash Flow will quickly figure out that they can skip the article and look for one about Trash Flow instead. Answer questions like who, what, when, and why. Picture an employee who has found your article in a search; they need to know if your article answers a question they have. Save this person time by telling them: a) who the article is for, b) what outcome they can expect (what they will know or be able to do after they read the article), and c) in what circumstances (or, when and why) your article will be useful.

Limit your scope statement to just a few sentences. This will make it easy for readers to skip it if they’re confident that they’re on the right page. Later, if they start to wonder if they’ve mistakenly landed on the wrong page, they can return to the top of the article to read the scope statement.

Try writing your scope statement after you’ve drafted the article. Describing the scope of an article is easier when you have content to draw from.

Before You Begin

What the user must have completed before starting the task

Context

Provides background information--what's it for, and what will they gain by doing it correctly. Should not be used as a replacement for a full concept topic.

Steps To Follow (use a 2nd person imperative verb here: Print the Bills, Upload the Routes, etc.)

What to do for each step
be succinct; no more steps than are necessary
May also include substeps, tutorial information, a step example, choices, or troubleshooting

When You're Done

Describes the expected outcome for the task as a whole; gives any extra steps that must be done.

Further Information