Skip to content
Help Center
Submit a request Sign in

Create, review, schedule, and publish a knowledge article

A good article lets another person solve a problem without reconstructing the original case. Authoring brings together the explanation, audience, topics, review, and publication controls. Use a draft to develop the answer, then follow the review route your permissions and article policy require.

At a glance

For: knowledge contributors, editors, reviewers, and publishers. Applies to: Supportbench Core.

Start here: Knowledge base → Create Article, or an eligible case activity → Create Article

Prepare a reusable answer  ·  Create and save a draft  ·  Follow the available review route  ·  Publish now or schedule a version  ·  Keep customer access intentional  ·  Give the article a maintenance path  ·  Build an article that another person can use without you  ·  Review as a customer-facing support operator  ·  Resolve common authoring problems

Prepare a reusable answer

  • Search for existing guidance and improve the canonical article when it already covers the task.
  • Verify the procedure against the applicable product behavior. Record prerequisites and a way to confirm success.
  • Remove customer names, private identifiers, credentials, and logs containing secrets. Choose an internal or restricted audience when the guidance is not suitable for every customer.
  • Confirm who owns the content and who should review it. The role permissions Create articles, Alter existing articles, Publish articles publicly, and Archive existing articles are separate. Articles require review before publishing can impose a review route. The separate Create article drafts from cases and chats permission supports a limited source-based contribution route. With only that permission, use Submit for Review; it does not grant ordinary Save as a Draft, general article creation, existing-article editing or publication rights.

Create and save a draft

The steps in this section apply to ordinary article authors with the required authoring permissions. If you only have Create article drafts from cases and chats, follow the source-based draft and Submit for Review procedure. Generation alone does not save an Article, and the limited contributor role cannot use ordinary Save as a Draft as an alternative to submission.

  1. Open Knowledge base → Create Article, or choose Create Article from an eligible case activity.
  2. Enter a task-focused Title, select the intended Division, and choose Visibility: Internal or External. External is an audience choice, not a publish action.
  3. Write a concise Summary. Choose relevant Topics and curated Tags. Add Search keywords for useful alternative names, error messages, or customer phrases when that control is available.
  4. Use an appropriate Template if offered. Write the prerequisites, numbered procedure, expected result, common problems, and related guidance.
  5. Use current images only when they clarify the steps. Crop to relevant controls, remove private details, and provide descriptive alternative text and a caption. The essential procedure should still work without the image.
  6. Preview the article and choose Save as a Draft. Draft content remains separate from the published version, and draft saves do not email subscribers.

Tags, Search keywords, and topic placements are shared article properties and can apply when saved even while content is a draft. Review those changes deliberately.

Core article authoring toolbar showing Cancel and Exit, Archive this Article, Save as a Draft, Finalize and Publish, and the active English version.
Review the active language and version before choosing a save action. Save as a Draft keeps draft content separate from published content. Shared tags, Search keywords and topic changes can apply when saved. Publication and any review route depend on the version state and your permissions.

Follow the available review route

The primary action reflects your permission and the article’s review policy. It can be Submit for Review, Approve and Publish, Approve for publication, Approve review, Schedule publication, or Finalize & Publish. Use the action shown; a contributor should not assume they can publish directly.

  1. Submit a complete, checked draft with enough context for the reviewer.
  2. Reviewers inspect the current submission and its comments/history in the Review pane. Check technical accuracy, audience, instructions, links, and media.
  3. Approve through the available action, or assign the submission back with specific corrections.
  4. Recheck changed content after correction. A review-required change must follow the approval route again.

Publish now or schedule a version

  1. Review Advanced version properties and enter a meaningful version summary where applicable.
  2. Set Publish on to schedule publication. Leave it blank for immediate publication when your available action permits it. Check the active time-zone context.
  3. Choose whether to enable Notify subscribers. Enable it only when eligible topic/article subscribers should receive a publication email.
  4. Complete the displayed review or publication action and read the result. A scheduled version is not yet a currently published version.
  5. Open the saved article in the agent reader and intended portal context. Verify the content, images, links, audience, and actual publication state.

Keep customer access intentional

Use Security to review applicable restricted tags, assets, asset categories, and customer roles. Asset/category restrictions do not automatically include children. Portal and topic rules also affect access. A tag, topic placement, or visible link is not a substitute for authorization.

Before sharing externally

Test with the intended customer scope. “I can open it as an agent” and “the article is External” are insufficient checks. Confirm that the correct version is published and the intended reader can access it.

Give the article a maintenance path

Set Next review date and the appropriate Review action when your team owns the resulting queue or action. Record a clear owner. Use feedback, case reuse, search terms, and relevant product changes to identify when the article needs another review.

AI-generated copy is a draft to inspect. Confirm facts, remove private case details, and check links and product scope before applying it. A confident paragraph is not evidence that the procedure works.

Build an article that another person can use without you

Begin with a specific reader and task. “Export problem” is too broad; “Check a failed nightly order export before retrying” tells the reader what this procedure helps them decide. Use a real verified resolution as evidence, then remove customer-specific detail. The outline below is an editorial example, not a product-specific fix to apply.

Article elementExample of useful contentWhy it matters
TitleCheck a failed nightly order export before retrying.Names the task and makes it recognizable in search.
SummaryExplains which export log to review, how to identify the failed stage, and when to ask the integration administrator for help.Helps the reader decide whether to open the article.
ApplicabilityThe supported integration, version and permissions actually verified by the author.Stops the procedure being used in a different environment.
PrerequisitesAccess to the relevant log and one failed request’s timestamp; explain how to obtain these.Avoids hiding a difficult step inside “check the logs.”
StepsExact navigation, the field/control to inspect, and the decision after each result.Makes the procedure followable by someone new.
Expected outcomeThe evidence that confirms success, plus what to do if it differs.Prevents “saved successfully” being mistaken for business recovery.
Search keywordsCustomer symptom wording and accurate alternate feature terms used in the article.Supports discovery without keyword stuffing.
Review questionCan a new authorized reader follow every step without asking what a term means?Tests practical completeness as well as technical correctness.

Keep the core answer early in a focused procedure. Use a broader feature guide to explain the concepts and choices, then link the focused tasks. A long guide and a focused task article have different jobs; neither should depend on unexplained prerequisites.

Review as a customer-facing support operator

  1. Follow the steps from the stated starting point with the intended role. If a menu is unavailable, determine whether the prerequisite is wrong or the role needs a separate procedure.
  2. Read every instruction beginning with “configure,” “run,” “select,” or “verify.” Confirm it explains where, what to enter/choose, and how to recognize success.
  3. Check alternative outcomes: missing permissions, an empty result, an existing record, a failed save, or an uncertain response. Cover the relevant cases explicitly.
  4. Check each example against the feature implementation and clearly label recommendations. Do not turn a suggested queue name, priority or schedule into a claimed default.
  5. Review the article in the portal and agent reader after publication, then search using the reader’s natural question. A successful save is only one part of publication quality.

Resolve common authoring problems

ProblemChecks and correction
Publish is not availableReview your permissions and the article’s review policy; use Submit for Review if that is the supported route.
A customer cannot open the articleCheck workflow status, External visibility, Security, portal/topic rules, and the customer’s role or asset scope.
The portal still shows older textConfirm which version is published, whether Publish on is in the future, and whether approval is still pending.
Subscribers received an unexpected emailReview Notify subscribers and the publication action. Draft saves do not send publication emails.
An image is missingCheck the saved article’s attachment/image reference and its rendering in both readers. Replace obsolete media through authoring.

Track your drafts and review submissions — upcoming, not deployed

Release status: This enhancement has been implemented and validated locally but is not deployed yet. The following steps describe the upcoming release and may not be available in your workspace.

Knowledge Base → Action Items → My drafts & submissions brings your saved draft articles and proposed updates together. Use it to follow your own contribution after work is assigned to another agent. My assigned articles instead follows the current owner. Neither list grants additional article or Division access.

You need existing Knowledge Base access. The list contains work identifiable as your saved draft revision or review submission, including revisions you last edited and articles you published directly. Unsaved editor text is not included. Deleted revisions and Trash are excluded; accessible archived articles remain available as history.

  1. Open Knowledge Base and expand Action Items. Select My drafts & submissions.
  2. Check the Division selector and active filters. The default list includes all personal work statuses without a date cutoff and sorts by Last activity, newest first. The badge counts distinct articles, not review rounds.
  3. Read Revision and My work status alongside Article status. There is one row per article, showing your latest qualifying work. A newer unsubmitted draft takes precedence over an older submission, even when a decision on that older submission arrived later.
  4. To narrow the list, choose Filters → Add condition → My work status, choose is and the required status, then select Apply filters. Use Title, Last activity or Submitted conditions when needed. Search matches your revision title, article ID and the article's title/summary; it is not a search through every historical revision body.
  5. Open the article by its title or ID. Use its authorized Review history to read feedback and earlier decisions. The list's Reviewer identifies the recorded decision author and can remain blank while work awaits review.
  6. Use Columns to select metadata, Save view for repeatable criteria, or Export for the complete authorized filtered list across all pages. A personal saved view resolves to its signed-in reader's own work, not the view creator's identity.
Personal work statuses describe your selected revision and review round
My work statusMeaning and next step
DraftYour saved revision has not been submitted for review. Open it and continue drafting or use the permitted submission action.
Pending reviewYour latest review round is awaiting a recorded decision. Check Submitted and the article's Review history before submitting again.
Changes requestedThe reviewer returned the submission for edits. Read the feedback, revise the draft and submit the correction through the existing workflow.
RejectedThe review round was rejected. Read the explanation and any authorized duplicate-article reference before deciding whether to revise or reuse existing knowledge.
ApprovedThe reviewer approved the work; this does not establish that the revision is already published. Check its publication schedule and current reader content.
PublishedThe selected contribution has a publication decision or direct revision publication evidence. The article's current lifecycle and customer visibility remain separate checks.
Review history unavailableThe available storage/history cannot establish the decision. This does not mean rejected or approved. Ask an administrator to check the review-history setup; do not create a duplicate to bypass it.

Worked example: an existing article is Published. You submit revision 4 to correct its refund instructions. Your row shows My work status: Pending review and Article status: Published; readers continue using the existing published revision. If revision 4 is Approved for a later publication date, its personal status remains Approved until publication is recorded. A rejection of revision 4 does not mean that the existing published article was removed.

Reporting versus your working list: open Reporting → Knowledge Base Reports → Report Type → Contribution outcomes for completed outcomes when that report is available in your release. Its deployment to Jackrabbittech has not yet been verified. It separates flagged articles marked Completed/Rejected from submitted drafts marked Published/Rejected. Credit belongs to the submitting agent and date filters apply to the outcome date, not the submission date. It does not replace this personal list of drafts and pending/approved work.

If work is missing: save the draft first, check Division and active filters, and verify that you created or last edited that revision or submitted its review. One article can have several revisions but only one personal-list row. Ownership alone does not establish authorship; reassignment does not itself remove a recorded submission, although a change in permissions can make the article unavailable. Older imported records may lack durable authorship/review history. Open the article through its normal authorized controls to check earlier work.

Flag a passage for an internal update review

Release status. Coming soon — not deployed yet. These passage actions and markers will become available after the matching release and verification for your account.

Use passage feedback when an instruction needs correcting and a reviewer needs to know exactly which wording you mean. This feature is available in the internal article reader and Ticket Knowledge drawer only. You must have article and Division access, Knowledge Base availability and the Flag articles for review permission. Configured reasons are required when starting a new suggestion.

Customer-facing portals never show passage flags, request counts or feedback. An agent with the required permission can flag an article in the internal application even when that article is also published publicly. Feedback details, restricted draft history and originating ticket links retain their separate access checks.

  1. Open the article inside the agent application, either directly or from the Ticket Knowledge drawer.
  2. Select the exact wording, or use the flag beside a paragraph, list item or section heading. The action becomes visible on hover or keyboard focus and is available on touch screens. A heading action captures its section up to the next heading of equal or higher level.
  3. Check the Selected passage quote and section name. Expand a long quote with Show more. Remove an unwanted passage before selecting another. Sections longer than 4,000 characters require a shorter selection. Your explanation remains in the form.
  4. Keep or remove the originating ticket badge. Choose a reason for a new suggestion, explain the correction and select Flag for update. If a suggestion already exists, read it and explicitly add your information to that thread.
  5. After a confirmed save, look for the passage flag marked Update requested. Open Update requests to navigate passage feedback, whole-article requests and contributions whose wording cannot be located.

Example and expected result

An article tells agents to choose Account settings to configure a payment gateway. Select that sentence and explain that the current menu is Integrations. The reviewer sees the saved quote beside your explanation, with an authorized ticket link when included. The original quote remains in the discussion after the article changes. The marker stays attached only while the wording and section can be located unambiguously.

Review and recovery

All contributions belong to the existing article-level suggestion. New and In progress suggestions keep their markers. Completing or rejecting that suggestion clears its active markers while preserving history. Flags inside overlapping passages share a marker. Ordinary whole-article feedback has no passage location.

Passage could not be located means the wording was changed, removed, repeated ambiguously or is unavailable in the displayed locale. Open the authorized feedback history to inspect its original snapshot. Do not assume the marker has moved to equivalent wording.

If a save is unconfirmed, use Retry previous save to resolve the same submission. If content changed before submission, keep your explanation, remove the stale quote and select current wording. If controls disappear, ask an administrator to verify the flagging permission, article access and account capability. Existing review-history access is separate from permission to submit new flags.

Validate authored Search keywords

Use complete, closely matching phrases that describe the article’s actual purpose. Preview the current top 20 and keyword emphasis in AI Terms search testing before requesting account-wide tuning. This read-only comparison does not save an account policy. Keep meaningful actions, conditions, numbers and negative wording. Objective/Solution headings are useful but optional; no new passage-ranking rule requires them.

Was this article helpful?