Hi. How can we help?
Search or ask a question
Getting startedSet up your first channel
Using FernbrookDaily workflow
Your profilePreferences and alerts
AdminRoles and retention
4
Launchboard#4 Product of the Day
The Complete
Documentation Portal
Playbook
A step-by-step guide, with real portal teardowns and a working toolkit, for shipping documentation your customers can actually navigate.
“We rebuilt our whole support library off chapter three alone. The category worksheet saved our team about two weeks of arguing in a doc.”
Priya Raghavan — Founder of Loomstack
01
What is a documentation portal
What is a documentation portal
and why does it matter?
A documentation portal is a self-serve library for your customers — the current, searchable source of truth for how your product works, what to do when it doesn’t, and where to go next.
A product documentation portal is…
Immediate answers for your customers.
You have heard this one before: it all starts with good customer service.
Unless you have shipped a flawless product (congratulations), your customers will have questions. They want the answer at the moment they are stuck — no email thread, no queue, no waiting for a reply from a different time zone.
A complete and current knowledge library has to be a first-class part of your support surface, not a folder someone updates twice a year.
One place for everythingA portal can hold every answer a customer needs in one place: product FAQs, common failure modes and their fixes, walkthrough videos, release notes, migration guides and integration references.
It lowers ticket volumeThe best part of a good portal is that it does not just help customers find answers faster — it also cuts the ticket volume your support team wakes up to every morning.
How can we help?
Search for articles
ProductEverything about the workspace, end to end. 8 articles
Pricing & PlansSeats, invoices, and what changes on upgrade. 6 articles
TroubleshootingFixes for the errors customers hit most. 11 articles
Use casesHow teams run their workflow here. 5 articles
Suggested · Migrating a legacy workspace
Suggested · Custom domains and SSL
How do I create a team?
1. Open workspace settings
2. Invite by email or link
3. Assign a default role
Adoption centre
Step 1 · Announce the portal
Step 2 · Link it from the app
Step 3 · Watch the search misses
02
Must-have qualities
Must-have qualities
of a great portal
A great portal is not simply a website with a pile of articles on it. It is made of a handful of concrete qualities that shape how quickly someone gets unstuck.
Responsiveness
Built for the desk and the train platform
Mobile share of documentation traffic has climbed every year we have measured it. On the 288 portals we crawled, a median of 47.2% of sessions arrived from a handheld device.
Your portal has to be genuinely responsive — readable at 360px, comfortable on a tablet, and unhurried on a wide desktop.
How can we help?
Search for articles
General infoWhat the product does and who it is for
Getting startedFirst workspace, first import
Working with docsStructure, drafts, publishing
CustomisationTheme, domain, navigation
Search
What are workspace roles?
Sharing a private space
Draft vs published
Search
A search bar that finds the answer, not the page
People arrive with a phrase, not a category. Search has to be forgiving of typos, weight titles over body text, and suggest articles as the query is typed.
Just as importantly, save and read the queries. Your search misses are the highest-signal backlog you will ever get for free.
How can we help?
domain
Domains · Connecting a custom domain
Domains · Verifying DNS records
Widget API · Hiding the launcher
General · Improving your portal for search
3 suggestions
No results → log it
Branding
A portal that still looks like your product
Customers deserve a library that feels like the app they just left. A good platform lets you set the accent colour, the surface tints, the type, the favicon and the navigation without a redesign project.
Theme & appearance
AccentApplied to links, tabs and buttons
SurfaceLight, dim or dark canvas
TypePick the family and the scale
NavHeader links and footer columns
Preview
Light
Dark
Analytics
Learn from readers and tune the library
Good portal software tells you how the library is actually used: sessions, most-read articles, dead-end pages, referrers, and the queries that returned nothing.
Prefer a privacy-friendly, cookie-less measurement approach — you avoid the consent banner and your readers’ behaviour is not resold to an ad network.
Last 30 days
1,423Page views
328Unique readers
Three ways to structure a space · 625
Which payment methods work · 411
Syncing your library · 268
Connecting a custom domain · 133
Discoverability
Search engines should surface your articles
Most people find your documentation through a search engine, not your navigation. To make that work you need control over the title, the description, the canonical URL and the social preview image on every article.
Article metadata
Meta title · Connecting a custom domain
Meta description · Point a subdomain at your portal
Canonical · /docs/custom-domain
Social image · og-domain.png
Score 94
Indexable
Sitemap found
Custom domain
Host the library on a domain you own
Put the portal on a subdomain of your main site with a word people already guess — support.yourdomain.com or docs.yourdomain.com. It keeps the brand intact and the links stable.
Wondering whether a subdomain or a subfolder is the better call? We crawled the field and counted.
Add a custom domain
loomstack.quillon.app
docs.loomstack.com · verified
Certificate issued automatically
Subdomain vs subfolder
The question behind the question — and we counted. We crawled 288 documentation portals across SaaS, fintech and developer tools, and the split was not close.
Subdomain
Subfolder
200150100500
Subdomain vs subfolder placement across 288 crawled documentation portals
64.3%
Subdomain
35.7%
Subfolder
The two most common prefixes were support. and docs. — between them, 71 of every 100 subdomains.
03
Five categories, one shape
Category structure
Which categories should the library have? It depends on your product, but four of them show up in nearly every portal worth copying — plus one that maps to your own feature set.
Getting started
Teach people the basics of the product and how to get to their first useful outcome.
What is {your product}?
How do I install and sign in?
{Your product} glossary
Billing & plans
Explain cycles, payment methods, where invoices live, and what differs between tiers.
How do I upgrade my plan?
How do I cancel a subscription?
Which payment methods work?
How can we help?
Search for articles
Getting startedThe basics of the product and the first run
Billing & plansCycles, methods, invoices, tiers
TroubleshootingCommon failures and their fixes
Profile & accountMembers, access, personal settings
FeaturesOne page per capability you ship
Another spaceDuplicate this one and rename it
Take our free category worksheet with all five spaces, example articles and the prompts we use to write them.
Troubleshooting
Use this space to walk people through the failures they hit most, in the order they hit them.
How do I fix {common issue}?
I found a bug — how do I report it?
Why can’t I do {common task}?
Profile & account
Cover member management, access levels, and the settings people change on themselves.
How do I change profile settings?
How do I delete my account?
How do I manage notifications?
04
Writing help articles
Nothing is worse than a help article that does not help. Articles are the whole point of the portal, so they have to be quick to scan and hard to misread. Five habits do most of the work.
What to write about
Naming your articles
Make content scannable
Use your customers’ words
Add visual elements
What to write about
Customers come to the portal to get out of a hole. Your job is to have already written the way out. Beyond the obvious questions covered in the category section above, the richest source of topics is sitting in your support inbox.
Tickets are the best record of what your users actually struggle with. Turning a ticket into a dedicated article the moment you answer it is the cheapest way to fill a library with content nobody had to invent.
Takeaway
Write one new article every time you answer a ticket for the second time.
Inbox · Support1–50 of 2,619
Ticket: how do I upgrade my plan?
Michaela Ruvo · 9:14 AM (8 hours ago)
Hello — we hit the seat limit on the starter plan and I need three more editors this week. I could not find the upgrade screen in settings, and I am not sure whether you prorate the remaining month. Could you point me at the right page? Thanks, Michaela
Looking into itWe will be thereThanks for the note
Draft · Upgrading your plan
Where the upgrade screen lives
How proration is calculated
What changes for existing seats
05
Six portals worth stealing from
These six came out of the crawl with the cleanest structure and the fastest path to an answer. Each is unusual in its own way, but they share a handful of habits.
Hi, how can we help?
Search the guides
Guides for getting started
Booking and cancellations
Payouts explained
Account and security
Reaching a human
What do you need help with?
Search
First stepsWhat Kestrel is for
Build a formFields and logic
SharingLinks and embeds
ResultsExports and webhooks
Welcome — search or browse
Search topics
BasicsAccounts and saving
PremiumWhat the paid tier adds
On mobileiOS and Android
SyncDevices and offline
Help Center
Ask about selling on Orbital
StartOpen a storefront
SellListings and orders
GrowFees and payouts
LegalTax and disputes
Advice from the Northfield team
Search for articles
Getting started with Northfield
Accounts and billing
Dashboards
Alerts and digests
Data retention
06
Tools & resources
Tools & resources
for building the portal
A short, opinionated list of the software we actually reach for when we build a documentation portal from scratch.
Showing 4 of 23 tools
Knowledge base
Screenshots
Visual guides
Video editing
Screen capture
Annotation
QuillonDocs portals, built right
Knowledge base
Quillon — ship a portal from the docs you already write
Point Quillon at your existing writing and it publishes a hosted, searchable, on-brand portal. Custom domain, analytics and an embeddable widget included.
CartularyDocumentation for growing teams
Knowledge base
Cartulary — structured docs with review workflows
Built for teams that need approvals before anything goes live. Versioned articles, scheduled reviews and a decent public changelog.
HelmsmanSupport desk & live chat
Support desk
Helmsman — inbox, chat and article suggestions
Answers common tickets from the library before an agent sees them, and flags every question that had no matching article.
ScribbetCapture, annotate, embed
Screenshots
Scribbet — annotated screenshots that stay current
Capture a flow once, blur what is private, and re-shoot the whole set when the interface changes without touching the article.
07
The documentation portal checklist
Everything above, compressed into eight things to tick off before you call the portal finished — and again every quarter after that.
Define the goal
Name what the portal is for — fewer tier-one tickets, faster onboarding, a specific deflection number — before you write a single article.
Organise the information
Structure spaces and articles the way a stuck customer would look for them, and make navigation and search both work on their own.
Be accurate and complete
Cover the real product, at the current version, with step-by-step instructions and a troubleshooting path for every step that can fail.
Design for reading
Short paragraphs, honest headings, generous line height, and an image only where a sentence genuinely cannot do the job.
Keep it current
Put a review date on every article and treat a stale page as a bug. Nothing burns trust faster than a screenshot of a screen that no longer exists.
Offer a way to respond
Give every article a “did this help?” control and a free-text box. Read the free text weekly; it is where the real wording problems surface.
Make it accessible
Check contrast, keyboard order, focus rings, alt text and heading levels. Test on a small screen and with a screen reader, not just on your monitor.
Measure and promote it
Track reads, deflection and search misses. Then link the portal from the app, the onboarding email and every ticket reply you send.
Found this useful?
Send the playbook to
Send the playbook to
a colleague or a friend
This guide took a long winter of crawling, reading and rewriting. If it saved you an afternoon, passing it on is the only thank-you we are after.
Thank you
L
Featured onLaunchboard
412
votes
votes
Written by the team behind Quillon
Build your documentation
Build your documentation
portal with Quillon
Hello — I’m Teodora Ilić, and I build Quillon.
Quillon turns the documents your team already writes into a hosted knowledge library, support portal or product manual. You keep writing where you write today; Quillon handles the publishing, the search index and the theme.
It is fast, flexible, and built for libraries that have to survive a few years of product changes. Drop the widget into your app so answers show up in context, and let the built-in SEO controls do the rest. Pages render from a static cache, so a cold article still opens in well under a second.
Writing, answering and adding a walkthrough video have never taken less setup. There is no code involved — connect a source, pick an accent colour, and publish.
Start a portal with QuillonTurn your documents into a portal
quillon.app/loomstack
Access controlPublic, private or gated spaces
ComplianceAudit trail on every publish
Install guidesPer-platform walkthroughs
Release notesAuto-dated, always public