Creating a help article in Userorbit takes just a few minutes. This guide walks you through the full process from navigating to the editor to publishing a live article on your knowledge base.
Step 1: Open the Help Center
From the Userorbit dashboard, click Help Center in the left sidebar. This takes you to the article list where you can see all your existing articles, their status (draft, published, or archived), and which collections they belong to.
Step 2: Start a new article
Click the New article button. Userorbit opens the article editor with an empty title and body. The editor is where you will spend most of your time, so take a moment to familiarize yourself with the toolbar and sidebar options.
Step 3: Write your title
Enter a clear, descriptive title that tells users exactly what the article covers. Good titles are specific and use the language your users would search for. For example:
- "How to reset your password" is better than "Password management."
- "Setting up SSO with Okta" is better than "Authentication options."
The title becomes part of the article URL and appears in search results, so clarity matters.
Step 4: Write the article body
Use the rich text editor to write your content. The editor supports:
- Headings (H2, H3) for structuring sections.
- Bold and italic text for emphasis.
- Bullet and numbered lists for steps and feature lists.
- Code blocks for technical content like API examples or configuration.
- Images — drag and drop or upload screenshots and diagrams.
- Links to other articles, external documentation, or resources.
Structure your article with a brief introduction explaining what the reader will learn, followed by the main content broken into logical sections with headings. End with any relevant next steps or related articles.
Step 5: Assign to a collection
In the sidebar, find the Collections field and select one or more collections for this article. Collections group related articles together on your knowledge base — for example, "Getting started," "Account management," or "API reference."
If the right collection does not exist yet, you can create one from the Help Center settings page and come back to assign it.
Step 6: Save as draft
As you write, Userorbit auto-saves your progress. You can also manually save by clicking Save or using the keyboard shortcut. New articles start in draft status, which means they are only visible to your team — not to users on your public knowledge base.
Use draft status to:
- Get feedback from teammates before publishing.
- Work on an article over multiple sessions.
- Prepare documentation ahead of a feature launch.
Step 7: Publish
When your article is ready, click Publish. The article immediately becomes visible on your public knowledge base and available to the AI conversation system. Users can find it through search, collection browsing, or direct link.
After publishing, you can still edit the article at any time. Changes are saved and reflected on the live version immediately.
Tips for effective articles
- Keep articles focused on a single topic. If you find yourself covering multiple subjects, split them into separate articles.
- Use screenshots liberally — visual instructions are faster to follow than text alone.
- Write for scanning. Most users skim headings and lists before reading paragraphs.
- Link to related articles so users can explore connected topics.