Academy

How-To Guides: Structure, Steps and Schema

Build a how-to guide that turns a reader's goal into ordered, testable steps with prerequisites, success signals, recovery paths, and troubleshooting.

15 min read

A how-to guide is an ordered procedure that takes a reader from a known starting state to a verified result. It answers “How do I complete this task?” without leaving the reader to invent a missing step.

Every step needs an imperative title, its reason, the action, an observable success state, and a recovery path. Click-only instructions work only when the reader’s account, access, data, and interface happen to match the author’s assumptions.

Reader question resolved: “What do I need, what do I do in order, how will I know it worked, and how do I recover if it did not?”

Questions it answers

A how-to guide serves informational intent , meaning the reader is trying to learn or complete a task rather than evaluate a list of products. The query often starts with “how to,” but wording alone is not enough. The intended outcome must be something the reader can perform and verify.

Write for the questions people actually carry into the procedure:

  • “Do I have the required plan, access, tools, and time?”
  • “Which actions must happen in order, and what should appear after each one?”
  • “Could this overwrite, publish, charge, delete, or expose anything?”
  • “How do I recover from a different result and confirm the complete task worked?”

The direct answer should state the result, the starting condition, the expected time, and the difficulty before the first long explanation. “In about 20 minutes, an account administrator can connect Search Console and verify the first successful import” is useful. “This guide explores integration best practices” is not.

When to use this post type

Procedures fail at assumption boundaries. The author knows which access, delay, or setting matters; the reader does not. This format makes hidden dependencies, state changes, and recovery decisions visible in sequence.

Confusable typeChoose it when the reader starts withAnswer shapeWhy it is not this type
How-to guideA goal: “I need to complete X”Prerequisites, ordered steps, success signals, recovery, completion checkIt is the procedure itself.
How to choose XA decision: “Which X fits me?”Criteria, alternatives, tradeoffs, recommendation“Choose” describes evaluation, not an action sequence with a testable result.
Troubleshooting articleA symptom: “X failed” or “I see error Y”Diagnosis tree from symptom to cause to fixIt begins after an attempted procedure has already produced a problem.
Documentation articleA need to look up behavior, fields, limits, or syntaxReference organized for retrieval rather than one reading pathIt supports many tasks and does not promise one narrative route to one outcome.

Choose a how-to only when order matters. If independent checks can be performed in any sequence, publish a checklist. If the topic is broad enough to contain several distinct goals, use an ultimate guide as the map and create separate how-to guides for the procedures. If the reader primarily asks what a concept means, use a what-is-X page .

Logo

Ready to Monitor Your AI Visibility?

Track how AI chatbots mention your brand across ChatGPT, Perplexity, and other platforms.

Best for these business types

Ranking reflects how often the model depends on a reader completing a repeatable process, not the overall value of content to the business.

  1. SaaS . Setup, configuration, migration, and recurring workflows determine whether users reach value. Distinguish plan limits, roles, interface states, and destructive changes.
  2. Ecommerce . Buyers need assembly, sizing, installation, use, and care procedures. Show physical orientation when words cannot do so safely.
  3. Local service . Preparation guides help customers gather inputs and understand appointments. Separate safe customer work from work reserved for a qualified professional.
  4. Marketplaces . Sellers, buyers, providers, and administrators may follow different workflows. State the audience and role before prerequisites.
  5. B2B services . Onboarding, approval, handoff, and review guides clarify ownership and show what complete work looks like.
  6. Media publishers and affiliates . Expert tutorials can serve task-led demand, but publishers must test the procedure and maintain captures rather than rewrite vendor documentation.

Search intent

Search intent is the outcome a person expects from a query. For procedural intent, the expected answer shape is an immediate feasibility check followed by an executable route: outcome, time, difficulty, prerequisites, ordered actions, verification, troubleshooting, and next step.

Task results can mix videos, step excerpts, product documentation, community answers, and tutorials. AI answers often compress the route into a numbered sequence with sources. Each extracted step must retain its object, condition, and expected result; warnings must sit before risky actions.

Capture both examples on the same date and record the query, location, device, signed-in state, and interface. Results change; the design lesson should come from the answer shape, not a claim that one provider always displays a particular feature.

Page structure

Word ranges control emphasis, not quotas. Add words only when they remove a decision the reader would otherwise make alone.

SectionWord rangePurposeStatus
Hero and direct answer60–100Name the result, reader, starting state, time, and difficulty.Required
Prerequisites120–220List access, tools, inputs, costs, versions, safety conditions, and irreversible commitments before work begins.Required
Quick overview60–120Preview the main phases and final success state without duplicating every instruction.Required
Ordered procedure700–1,500Carry the reader through imperative, reasoned, testable, recoverable steps.Required
Completion check100–180Verify the end result with observable evidence and list what “done” includes.Required
Troubleshooting250–500Resolve common failures of this procedure by symptom, likely cause, and next action.Required
Variations150–350Explain meaningful plan, device, role, or version differences.Conditional
FAQ200–350Answer residual questions that do not belong inside a step.Required; 5–7 questions
CTA40–90Offer one logical action after the reader has completed or evaluated the task.Required

Required elements

The step list owns the procedure contract. Prerequisites protect its starting state, and the closing check proves its promised outcome; neither has a separate element page, so they remain named structural sections rather than invented elements.

ElementStatusExact positionWhy it belongs there
step listAlwaysAfter prerequisites and the quick overviewThe sequence is the page’s core deliverable; every step contains reason, action, success, and recovery.
Annotated screenshotConditionalImmediately after the instruction whose interface or state is ambiguousA capture resolves spatial ambiguity only while it remains adjacent to the relevant action.
Tip boxConditionalAfter the required instruction it improvesOptional optimization must not be mistaken for a condition of success.
Warning boxConditional, mandatory when risk existsBefore the risky or irreversible actionA warning can change behavior only before the consequence is triggered.
FAQ structureAlwaysAfter troubleshooting, before the CTAResidual questions belong after the complete procedure so answers do not fragment the sequence.
CTA blockAlwaysFinal content blockThe next action becomes reasonable only after the page has delivered the promised outcome.

When screenshots are mandatory

A screenshot is mandatory when text cannot reliably identify the correct control, location, state, orientation, or result. Use one for similar controls, hidden settings, unlabeled visual states, or physical parts that could be confused. Crop to the decision area, retain orientation context, mark the target, and explain it in text.

A screenshot is noise when it repeats “Select Save,” shows a whole screen for one obvious control, or replaces text. Never make an image the only source of a command, warning, value, or success criterion.

Frontmatter

The frontmatter must describe the procedure as precisely as the visible page does.

FieldRequired value or rule
entityA stable verb–object value for the task, such as connect-google-search-console, not the broad topic search-console.
schemaTypeHowTo when the visible page is an ordered procedure with a result; otherwise Article.
nameSame task name readers see in the title or direct answer.
descriptionConcise result and scope, not a list of keywords.
totalTimeHonest ISO 8601 duration derived from tested completion time; separate waiting time in visible copy.
estimatedCostInclude only when the procedure requires a purchase or fee, using the visible amount and currency.
supply and toolList only items named in the visible prerequisites. Do not call software access a physical supply.
stepSame count, order, names, text, URLs, and images as the visible steps.
inLanguage and datesMatch the published language and visible publication or modification record.
FAQUse 5–7 real residual questions in [[faq]]; any visible accordion and structured data must match them exactly.

Schema markup is machine-readable data about visible content. Publish HowTo as JSON-LD only when implementation is faithful. Never mark a prerequisite as a step, merge visible steps, add hidden instructions, or attach the wrong image. Use Article when exact correspondence cannot be maintained.

Full example

This copy-pasteable skeleton uses a real task. Bracketed production prompts specify the evidence a writer must insert.

# How to connect Google Search Console to Northstar Analytics

Connect a verified Search Console property to Northstar Analytics so its first query report can import. An account administrator can complete the setup in about 15 minutes; the import may take up to 30 additional minutes. Difficulty: beginner.

## Before you start

- A Northstar Analytics account with the Administrator role
- Owner access to the Search Console property you will connect
- The exact HTTPS property that matches the site's canonical host
- Permission to share Search Console performance data with Northstar Analytics

Do not continue with a test property or a different host. The connection can succeed technically while importing data for the wrong site.

## Quick overview

You will select the site, authorize access, choose the matching property, start the import, and verify that a dated query row appears in Northstar Analytics.

## 1. Confirm the site and property match

**Why this step exists:** Search Console can contain domain and URL-prefix properties with similar names. Choosing the wrong one produces a valid connection with irrelevant or incomplete data.

**Do this:** In Northstar Analytics, open the site's Settings page and copy its canonical host. In Search Console, confirm that the intended property includes that host and protocol.

**When it worked:** The host shown in both products matches exactly, including `www` and HTTPS.

**If it did not:** Ask the property owner which property represents production. Do not guess from its display name.

## 2. Start the Search Console connection

**Why this step exists:** Starting from the selected site binds the authorization to the correct Northstar Analytics workspace.

**Do this:** Open **Settings → Integrations → Google Search Console**, then select **Connect**.

**When it worked:** A Google authorization window names Northstar Analytics and asks you to choose an account.

**If it did not:** Allow pop-ups and retry. If Connect is disabled, confirm your Administrator role.

[Insert a cropped, annotated capture of the Integrations panel only when Connect is difficult to distinguish from another control.]

## 3. Authorize the correct Google account

**Why this step exists:** Northstar can list only properties the authorized Google account can access.

**Do this:** Choose the Google account that owns the intended property, review the requested access, and approve it.

**When it worked:** You return to Northstar Analytics and see a property selector.

**If it did not:** Use a private window and repeat authorization with the property-owner account.

## 4. Select the production property

**Why this step exists:** Authorization proves account access, but the selected property determines which data is imported.

**Do this:** Select the property that exactly matched the canonical host in step 1, then choose **Save and import**.

**When it worked:** The integration status changes to **Import queued** and displays the selected property.

**If it did not:** Return to step 3 with an authorized account. Compare full identifiers when properties look alike.

## 5. Verify the first import

**Why this step exists:** A connected badge proves authorization, not that usable data reached the report.

**Do this:** After the displayed waiting period, open **Reports → Search queries** and set the date range to a period that has Search Console data.

**When it worked:** At least one row shows a query, landing page, date, clicks, or impressions from the selected property.

**If it did not:** For **Import queued**, wait and retry. For **Permission expired**, reconnect. For **No data**, check the date range and source property.

## Completion checklist

- The integration names the intended production property.
- Its status is Connected rather than merely Queued.
- The query report contains a dated row from that property.
- A second administrator can identify which account owns the connection.

## Troubleshooting

### The property selector is empty

The authorized Google account lacks access or access was removed. Reauthorize with a property owner, then reload the selector.

### The connection succeeds but the report is empty

Compare the report date range with Search Console, then confirm the exact property identifier before disconnecting.

### The import repeatedly returns to Queued

Record the site, property identifier, start time, and latest status, then contact support. Those details let support inspect the import without asking you to repeat authorization blindly.

## FAQ
[Add five to seven residual questions about permissions, data delay, property types, reconnection, and removal. Do not repeat the steps.]

## Next steps
[Offer one action that uses the imported data, such as reviewing the first query opportunity report.]

Design examples

Every gallery variant must show the same prerequisites, five steps, success states, recovery text, troubleshooting, and completion check.

Quality checklist

A guide is publishable only when a reviewer can complete it from a clean starting state without the author.

  • The hero states one testable outcome, the intended reader, expected active time, waiting time, and difficulty.
  • Prerequisites name roles, access, versions, tools, inputs, charges, and safety conditions that could block a later step.
  • Every step starts with an imperative title and explains why, action, success, and recovery.
  • The order has been tested; moving a step would change, block, or invalidate the result.
  • Warnings appear before risk, and optional tips never hide required work.
  • Screenshots resolve genuine ambiguity, have current interface context and accessible explanations, and are not the only source of instructions.
  • The final check verifies the promised outcome rather than the final click.
  • Troubleshooting covers observed or credibly reproducible failures with specific next actions.
  • HowTo data matches every visible step and property exactly, or the page uses Article instead.
  • A second tester has completed the guide on the supported account, device, role, and version.

Common mistakes

The most common failure is a click transcript: “Open Settings. Click Integrations. Click Connect.” It omits why the property matters, what should appear, and how to recover from missing permission.

Other failures are equally specific:

  • Hiding prerequisites inside steps. Discovering at step 4 that administrator access takes a day to obtain wastes the reader’s time and may strand partial work.
  • Putting warnings after actions. A deletion warning below the Delete instruction cannot prevent deletion.
  • Using elapsed time as active time. “Takes 40 minutes” is misleading when the work takes 10 minutes plus a 30-minute import. State both.
  • Testing only the author’s account. Administrators often see controls that ordinary members do not. Test the role named in the hero.
  • Treating the final click as success. “Saved” may mean only that a request was accepted. Verify the downstream state or output.
  • Letting schema drift. Renaming, reordering, or merging visible steps without updating HowTo data creates two incompatible procedures on one URL.
Test from a clean state
Use an account, browser profile, device, and data state that match the declared reader. Familiarity can conceal missing instructions just as effectively as missing permissions.
Do not publish an unverified recovery path
A plausible fix can overwrite good data or make diagnosis harder. Reproduce each recovery path safely, or state the condition that requires escalation instead of guessing.

Internal linking

A how-to links outward only when the destination explains a prerequisite, supports a decision, or provides the next procedure. Define specialist terms before the sequence or at first use.

Other pages should link to the guide when they name the exact task but should not duplicate its steps. A product page can link from a capability to setup. An ultimate guide can link from a broad phase to the relevant procedure. A troubleshooting article can link back to the guide’s starting state after the symptom is resolved.

Do not duplicate a “how to choose” decision guide, a symptom-led troubleshooting path, or general documentation. If a sibling page needs more than a short summary of the same sequence, establish one canonical procedure and link to it. Keep version-specific variations on one page when the main route is shared; split them only when the steps or prerequisites materially diverge.

How to measure results

Measurement follows the guide’s promise: was the procedure found for the intended task, selected as a useful source, followed, and connected to a meaningful next state? Use AI rank tracking to monitor recurring goal-shaped prompts, then inspect Prompt Tracking for the answer wording, cited URL, engine, and competitor sources. The working deep link is open Prompt Tracking .

Record the prompt set and a pre-publication baseline. Track citations separately from brand mentions. On-site, use completion evidence such as reaching the final check, selecting the next-step CTA, completing an associated product event, or reduced support demand. Each is evidence, not proof; scroll depth cannot show that the procedure worked.

FAQ

Frequently asked questions

What makes a how-to guide different from documentation?
A how-to guide leads one reader from a defined starting state to one verified outcome in sequence. Documentation organizes facts for reference and may support many goals without prescribing a single path.
Does every step need a screenshot?
No. A screenshot is required when words cannot reliably identify the control, state, or result. It is noise when the action is unambiguous, the interface changes often, or the image merely repeats the sentence.
How many steps should a how-to guide have?
Use as many steps as the real procedure requires. Three to ten is a useful working range; group a longer procedure into phases rather than hiding several dependent actions inside oversized steps.
Should a how-to guide include HowTo schema?
Use HowTo structured data only when the page visibly presents an ordered procedure that produces a result. Every marked-up step, tool, supply, time value, and image must match what readers can see.
Where should troubleshooting appear?
Put a short recovery path inside every step, then add a consolidated troubleshooting section after the procedure for failures that span steps, have several causes, or require diagnosis.
How should a team measure a how-to guide?
Track visibility for goal-shaped prompts, citations to the guide, engaged completion signals, support deflection where available, and the next action. No single metric proves successful task completion.

Put the guide into production

Test the procedure with a representative reader, then use the CTA block to offer one action that follows naturally from verified completion.

← All Academy tutorials

Ready to put it into practice?

Free check · 7-day trial · no credit card