Knowledge Base

Knowledge Base Overview

Write articles once and publish them to your team, your customers, or both — with categories, audience controls, and a searchable help center.

What the Knowledge Base is for

The Knowledge Base is where your organization writes things down: runbooks, how-tos, policies, troubleshooting guides, onboarding notes, answers to the questions your customers keep asking.

You write an article once. Then you decide who reads it:

  • Your team, inside DevStride.
  • Your customers, through the Service Desk portal's Help center.
  • Both — the same article can serve internal readers and customers at the same time.

That last point is the whole idea. A troubleshooting guide your support team relies on is usually the same guide a customer needs at 2am. Instead of maintaining two copies that drift apart, you maintain one and point it at both audiences.

The three places articles live

It helps to know these by name, because they behave differently and the documentation refers to them constantly.

1. The Library — where your team reads

Knowledge Base in the left navigation.

The Library is the reading room. It lists the published articles you can read, browsable by category and searchable by keyword. Every member of your organization can open it — no special permission required. Out of the box everything is shared with the whole organization; when an article or category is shared more narrowly, members it is not shared with simply do not see it.

The Library shows internal articles and customer-facing ones, so your team gets the complete picture. They are split across three tabs: Internal Articles, External Articles and Specifications. Internal-only articles carry an Internal badge so a reader can tell at a glance whether a customer could also be looking at it.

The Library never shows drafts — not even to the person who wrote them. Drafts are previewed while you are editing them, not published to a reading surface.

2. Manage articles — where your team writes

Manage articles, reached from the button at the top right of the Library.

This is the authoring surface: a table of the articles you can see in every state, under the same three tabs as the Library, the editable category tree, and the controls for filing, ordering, sharing, and publishing. It is also where you turn on approval for published changes in a category, and watch the categories you care about. The stages your specs move through are set up in Configure Settings → Knowledge Base → Stages. It requires at least one Knowledge Base permission, so members who only read never see it. The article editor is also where reviewers leave review comments.

3. The Help center — where your customers read

/portal/<your-portal-slug>/kb, reached from Help center in the portal's menu. Articles in a category that holds specs are listed on the portal's Specs page instead.

Customers see a deliberately narrower slice: only articles that are published, marked for the portal, not hidden by a category, and shared with their company. Everything else is invisible to them — not greyed out or locked, but genuinely absent.

::alert{type="note" title="Customers see "Help center", not "Knowledge Base""} The customer-facing surface is branded Help center throughout the portal. The two names refer to the same articles; only the wording and the visible subset differ. ::

How an article reaches a reader

Every article carries three independent settings. A reader sees the article only when all three allow it. This is the single most important thing to understand about the Knowledge Base, and it has its own page.

SettingQuestion it answersApplies to
StateIs it finished? (draft / published / archived)Everyone
VisibilityIs it for customers, or team-only? (Portal / Internal)Customers
Category audienceIs the section it lives in customer-facing?Customers
CompaniesWhich customer companies may read it?Customers

Visibility, category audience, and companies do not decide whether a member can read an article in your team's Library. They exist to control the customer side, though visibility and category audience also decide which tab lists the article. Which members can read, comment on, or edit an article is a separate control, Sharing — see Sharing articles and categories.

A tour in one paragraph

You click New Article and get a draft called Untitled article. You type a title and body; it saves as you go. You file it into a category, choose whether it is for customers or internal only, and click Publish — which mints a permanent URL slug. From then on it appears in your team's Library immediately, and on your customers' Help center if you pointed it at them. Later you can unpublish it back to a draft, or archive it when it is no longer relevant. Nothing is ever deleted.

Where to go next

  • Write and publish your first article — the step-by-step walkthrough. Start here if you have never used the module.
  • Organizing with categories — building the tree your readers navigate.
  • Who can see an article — visibility, the category audience clamp, and company sharing. Read this before you publish anything sensitive.
  • The article lifecycle and URLs — draft, published, archived, and how slugs work.
  • Article history and restore — who changed what, and going back to an earlier version.
  • Searching and browsing — the three tabs, how readers find things, and how ranking works.
  • The customer Help center — what your customers actually experience.
  • Sharing articles and categories — which members can read, comment on, or edit each article and category.
  • Article review comments — threaded review feedback inside the article editor.
  • Customer comments on articles — let customers ask questions under an article in the Help center, and answer them from the editor.
  • Client spec drafts — let customers write and edit draft specs on the portal's Specs page, in categories you open to them.
  • Spec stages — name the stages your specs move through and show each article's stage as a badge, to your team and your clients.
  • Specs and work items — link a spec to the work items built from it, create them from the spec or by automation when it reaches a stage, and find specs that still have none.
  • Spec checks — let DevStride's AI write an As Built for each finished work item, compare it with its spec, check a spec's progress at any time, and track every difference in one report until someone decides on it. Clients who wrote or approved the spec are emailed, and read the differences in the portal in wording written for them. Off until an admin switches it on.
  • Formwork requirements — import requirements from one or more OpenRegulatory Formwork products as specs, be told when they change or a spec's wording drifts from them, send a reworded spec's wording back, and send implementation evidence, design outputs and test results back.
  • Approval for published changes — make edits to published articles in a category wait for a publisher's approval.
  • Watching articles and categories — be told in the app when a spec changes stage, gets a new version, or has a change proposed or decided.
  • Knowledge Base permissions — who can write, publish, review, and curate.

What the Knowledge Base does not do yet

Worth knowing up front so you can plan around it:

  • No article templates. Every article starts from a blank editor.
  • No delete. Archiving is how you retire an article. This is deliberate — a published URL that suddenly 404s is worse than one that quietly stops being listed.
  • No bulk actions. Filing, publishing, and audience changes are one article at a time.