November 16, 2026

How to Review a Help or Documentation Layout

Keep a help or documentation layout that makes a task easy to find, shows a concrete next step, and is consistent in how it is reached.

An open aluminum toolbox with a lifted tray holding a folded instruction card with bullet lines, a chrome key, and a blue screwdriver, with a blue latch on the front, on an orange background.
In this guide

A student at the fictional music school Reed & Meter is looking for instructions on preparing for a first lesson: what to bring, when to arrive, and how to change the time if they cannot make it. The Help page reads like a second About page. It tells the school’s story, and it does not show a task, a concrete next step, or a way to look up a single detail. A practice note about returning to an instrument after a break may be useful on another day, but it is not the help this student needs now.

Reed & Meter is a teaching example, not a test result. The useful question is whether this help layout lets the visitor find the right kind of answer and use it.

If the page is actually a blog or article template, use How to Review a Blog or Article Layout. This guide is about help and documentation layout, not about general article typography.

Use these questions as a way to think, not as a score:

  • Is the visitor trying to learn a new skill, complete a specific task, look up a detail, or understand a concept?
  • Does the layout make that kind of help identifiable?
  • Is the answer structured so they can use it, with a concrete next step?

Lead With Tasks, Not a Brochure

Nielsen Norman Group’s heuristic on help and documentation (2020) says that information should be easy to search, focused on the user’s task, list concrete steps to be carried out, and not be too large, and that proactive help should be supplemented with a documentation repository that users can refer to as needed.

Diátaxis is a practitioner framework, not a study. It distinguishes tutorials, how-to guides, technical reference, and explanation, and proposes that documentation be organized around those needs. It is not “proven in practice” as a tested result. Use it as a way to classify what a visitor might be looking for, not as a guarantee that one structure will work.

The questions at the top of this guide turn that distinction into reviewer prompts: learn a skill, complete a task, look up a detail, or understand a concept. That is this guide’s synthesis, not a finding. On Reed & Meter’s Help page, “preparing for a first lesson” is a specific task. “What to bring” is a detail. “Why we start mid-term this way” is an explanation. A page that only tells the school’s story does not identify any of those kinds of help.

Whether the site as a whole should present the organization, help people complete a task, or do both, belongs in Brochure Site or Task-Led Site?. This guide does not retell that sitewide choice.

Make Help Easy to Find, and Consistent

No source supplied for this guide tests help-center layouts, such as a sidebar versus top navigation, or says exactly where a “contact support” link must sit. Those prompts are this guide’s judgment, not a finding. Ask whether topic and navigation labels make the available help identifiable, and whether the current page still orients the visitor once they are inside an article.

If help or contact options appear on more than one page, ask the team whether those mechanisms keep the same relative order. WCAG 2.2 Consistent Help, at Level A, is the relevant criterion. Online Website Previewer previews one address at a time, so this current-page preview has not settled that question. How to Check Visual Consistency Across Your Website is the wider consistency check. What else belongs in the footer, including a Help or Contact link, is covered in What to Put in a Website Footer.

WCAG 2.2 Multiple Ways, at Level AA, is a team question about whether there is more than one way to locate a help page, such as search plus navigation. GOV.UK breadcrumbs are one government system’s pattern for helping people understand and move between multiple levels, and they are not recommended on a flat structure or for showing progress through a journey. Use that as a prompt if the help section is hierarchical, not as a requirement.

If part of the help area is member-only, previewing a password-protected page often does not work, and public pages and staging sites without a login work best. Use a public help page for this visual review, and ask the team for a safe way to review any member-only area.

Paste the public help page’s address into the previewer and press Preview. That address opens in all three frames: phone 390 by 844, tablet 820 by 1180, and desktop 1920 by 1080 CSS pixels. The previewer is a visual check of layout in your current browser, not a test of a particular device. Check whether the task, the labels, and the next step stay clear at each width.

If a help article is long enough that a contents list would help, use In-Page Jump Links for Long Service Pages, or Split the Pages?.

Send a Keep or Rework Note

A useful note might say: “At [address], I checked the phone, tablet, and desktop previews at 390 by 844, 820 by 1180, and 1920 by 1080 CSS pixels, respectively. In the tablet preview, Help reads like a second About page. A student preparing for a first lesson cannot see a task, a concrete next step, or a way to look up a single detail such as what to bring. Please lead with identifiable tasks and short, usable answers, and keep the school’s story on About. This is a layout suggestion, not a finding that one help-center pattern is best.”

For how to phrase the note, see How to Give Useful Feedback on a Website Design.