Knowledge Base

The Customer Help Center

What your customers experience — reaching the Help center, browsing and searching, how specs are kept on their own page, and the article suggestions shown while they submit a request.

What customers call it

In the Service Desk portal, the Knowledge Base is presented as the Help center. Same articles, customer-facing wording, and a deliberately narrower selection.

How customers reach it

Signed-in portal users open Help center from the portal's side menu, or search it from Find an answer on the portal's Home page. It opens at:

/portal/<your-portal-slug>/kb

An individual article lives at:

/portal/<your-portal-slug>/kb/<article-slug>

Customers must be signed in to the portal to read the Help center. It is not a public, anonymous documentation site.

What customers see

Only articles that pass every gate:

  • Published — drafts and archived articles never appear.
  • Visibility: Portal (customers) — internal articles never appear.
  • No Internal category above them — a hidden section takes its contents with it.
  • Shared with their company — either All companies, or a list including theirs.

Everything else is genuinely absent: not in the category tree, not in search results, and the direct URL returns "not found".

Articles in a category that holds specs are not listed in the Help center at all: not in Browse articles, the category tree or search. They appear on the portal's Specs page instead, under the same rules, and a direct link to one still opens it.

Uncategorized articles are grouped under General.

In a category whose changes need approval, customers keep reading the published version while your team works on a proposed change. They see the new version only once a publisher approves it.

Browsing and searching

The Help center opens on Browse articles, showing the categories and articles available to that company in the order you curated on the Manage surface. Your arrangement reaches customers — the most important article in a section is the one you put first, not the one that happens to start with "A".

The search box is labelled Search articles, with the placeholder Search the help center…. Results appear under Search results, ranked exactly as they are for your team — exact title matches first, then title-prefix, then title-contains, then body relevance.

Customer-facing messages:

SituationWhat they see
Nothing published for themNo articles have been published yet.
Search found nothingNo articles match your search.
Could not loadWe could not load the help center. Please try again. with a Try again button
Article failed to loadWe could not load this article. Please try again.

An article's back link reads Back to help center, or Back to specs when it was opened from the Specs page.

Stages on articles and specs

If your team uses stages, a staged article shows its stage as a small coloured badge: under its title in Browse articles, under the title on the article page, on the portal's Specs page (which groups published specs by stage and badges each draft), and on the spec page. Search results do not show it.

Customers see only the stage's name and colour, never whether it is kept for publishers, and they cannot change it. So name your stages for a customer to read.

Comments under an article

On an article where you have switched on Allow customer comments, customers see a Comments section below it. They can read the public conversation, post a comment or reply, and edit or delete their own. Your team's answers appear as Support. Comments are off for every article until a publisher turns them on. See Customer comments on articles.

Specs have their own page

The Help center lists help articles only. Specs, the articles a client shapes with your team, are on the portal's Specs page: specs waiting for the client's approval, the company's drafts with Write a new spec, and the published specs grouped by stage. You decide which articles are specs with a category's This category holds specs switch. See Specs in the customer portal and Client spec drafts.

With spec checks switched on, a spec's page also lists the differences found between the spec and what was built, in wording written for clients. See What your clients see.

Article suggestions on the request form

The Help center also works to prevent tickets. When a customer is submitting a request, the form searches your published articles as they describe their problem:

  • Prompt: What do you need help with?
  • Placeholder: Describe your problem…
  • Matches appear under These articles may help
  • If nothing matches: No matching articles — go ahead and submit your request.

This is the highest-value place your Knowledge Base pays for itself. A customer who finds the answer here never files the ticket.

Testing what customers see

You cannot fully verify the customer experience from the authoring surface, because the Library deliberately shows your team everything.

  1. Quick check — in the article editor, look for Live on your customer portal under the slug. If it is there, the article passes the state, visibility, and category gates. It does not tell you about the company list.
  2. Company check — the Companies summary in the editor's Audience panel. All companies, or the specific list.
  3. Full check — open the portal as a customer of the relevant company and browse the Help center. This is the only way to see exactly what they see, including ordering and category structure.

Getting the most out of it

Start with your ticket queue. The articles worth writing first are the answers your team is already typing repeatedly. Look at your most common request subjects and write those.

Put the customer-facing sections first. Category order is yours to set, and customers read top-down.

Use Internal categories for the working half. Keep runbooks, escalation procedures, and internal notes in an Internal section. Your team finds them in the Library under Internal Articles; customers never know they exist.

Stage a section before launch. Build a new section under an Internal parent category, get every article right, then flip the parent to Portal. Everything goes live at once, already configured — and if you need to pull it back, flipping it to Internal restores exactly the state you had.