Overview
The Knowledge Base Library turns your Knowledge Base into a managed library. It has public and internal sections, nested groups, owners and review dates, version history, read-and-confirm acknowledgments, and step-by-step How-To guides that you can record with a browser extension and tidy up with AI.
Open it from the usual Knowledge Base menu item. The old Knowledge Base pages lead to the Library automatically.
|
What you want to do |
Permission you need |
|---|---|
|
Read internal articles |
Knowledge Base View, plus access to the article's group |
|
Write new articles, record How-Tos, use AI cleanup |
Knowledge Base Create |
|
Change existing articles, restore versions |
Knowledge Base Edit |
|
Manage groups, AI settings, everyone's capture keys |
Administrator |
The Library page has a search box and a type filter at the top, and these buttons along the header:
- New Article
- New How-To
- Capture extension
- To acknowledge, shown only when something is waiting for you
- Reviews
- Groups
- AI settings, for administrators only
Groups
Every article sits in a group. Groups are either Public, shown on your customer portal, or Internal, for staff only, and they can be placed inside one another.
To create a group:
- Click Groups, then New Group.
- Enter a name, and under Place inside, pick a parent or leave it at (Top level).
- Under Who is this group for?, choose Public or Internal. A group inside another one follows its parent's audience.
- Optional: tick Limit this group to selected roles or staff, then pick roles and staff members. Administrators always keep access, and groups inside it inherit the limit.
- Save.
Good to know:
- Starting fresh: Create starter groups adds a ready-made set of groups and never changes existing ones.
- Deleting: a group that has groups inside it can't be deleted until those are moved or deleted.
- Moving articles: to move several at once, tick them on the Library page and use Move to group....
- Internal articles in a public group: they stay hidden from customers. The Library shows a notice so you can move them into an internal group.
Articles
Click New Article, fill in the title, group and text, and click Submit. The fields below sit alongside the text and make the Library easier to manage.
|
Field |
What it does |
|---|---|
|
Group |
Where the article lives. A note under it says whether it will show on the customer portal. |
|
Internal only (hide from the customer portal) |
Keeps an article in a public group off the portal. |
|
Article type |
SOP, Policy, Technical Guide, How-To, Reference, Training Material or FAQ. The Library can be filtered by type, and How-To opens the step editor. |
|
Document owner |
The person responsible for keeping it accurate. |
|
Review schedule / Next review |
How often it should be checked. See Reviews below. |
|
Related articles |
Linked articles shown under the article as See also. Customers only see links to public articles. |
|
Requires acknowledgment |
Asks chosen staff to confirm they've read it. See Acknowledgments below. |
|
Disabled |
Saves the article as a draft that readers can't see. |
|
What changed? |
An optional note saved in the version history. |
Staff read articles with View article. A public article also has Open on portal.
Version history and acknowledgments
Version history: every save keeps a version, with who saved it, when, and the "What changed?" note. Nothing is lost when you edit.
- Open the article and click Version history.
- Click a version to read it, or Compare with current to see the differences. Green lines were added since that version, and red lines were removed.
- To go back, click Restore. The current text is kept as another version, so you can switch back at any time. For a How-To, the steps come back too.
Acknowledgments: use these when staff must confirm they've read a policy or procedure.
- Edit the article and tick Requires acknowledgment.
- Pick who: All staff, chosen roles, or chosen staff members. Only people who can open the article's group are included.
- Save. Each person gets a notification.
- When you publish a significant change later, tick Ask everyone to acknowledge this new version again.
For staff: a banner on the article asks you to read it. Confirm with I have read and understood this at the bottom of the page. The To acknowledge button on the Library page lists everything waiting for you.
Tracking: Acknowledgment report on the article shows who has acknowledged, who hasn't yet, and who needs to re-acknowledge a newer version. Remind those outstanding sends them another notification.
Reviews
Review dates keep articles from going stale.
- Setting it up: on the article, set a Review schedule (every month, 3 months, 6 months or year). Leave Next review empty to have it calculated from the schedule.
- Status: each article shows Up to date, Review due soon or Review overdue.
- Reviews page: the Reviews button lists articles with their owner and next review date. Filter it by Due or overdue, No owner or Only articles I own. A red count on the button shows how many are overdue.
- Reminders: the document owner gets a notification when a review is due. Checks run once a day.
- After checking an article: click Mark as reviewed. The next review date moves forward by the schedule.
How-To guides
A How-To is an article built from numbered steps, each with a short instruction, an optional note and a screenshot. Click New How-To, or set Article type to How-To on any article, and the text editor is replaced by the step editor.
Building the steps:
- Steps: Add step adds an empty step. Add screenshots as new steps turns several images into one step each.
- Pasting: paste a screenshot with Ctrl+V and it goes into the selected step.
- Step buttons: each step has Move up, Move down, Insert a step below, Merge with the next step and Delete step.
- Text around the steps: fill in the Introduction at the top and the Closing tip at the bottom.
Editing a screenshot: click it, or click Edit screenshot, to open the image tools.
|
Tool |
Use |
|---|---|
|
Click marker |
Click where the reader should click. A red circle is drawn there. Remove marker takes it away. |
|
Blur |
Drag a box over anything private. The blur is saved into the picture itself, not just laid over it. |
|
Crop |
Drag a box around the part to keep. |
|
Undo |
Steps back one change. |
Click Apply to keep your changes, then Submit to save the article. Screenshots in internal articles are only shown to staff who can open that group.
Download and print: every How-To has Download PDF and Print buttons on its staff page. Public How-Tos also have a Download PDF box on the customer portal.
Capture extension
The TruDriveSync How-To Capture extension records a task as you do it, on any website, in Chrome or Edge. Each click becomes a step with a screenshot, a red circle where you clicked, and an instruction such as Click "Save". The steps arrive in your Library as a draft How-To, which you review before publishing.
One-time setup:
- In the Library, click Capture extension. You need Knowledge Base Create permission.
- Name a key, for example "Work laptop". Click Create key, then Copy. The key is shown only once, so treat it like a password.
- Install the TruDriveSync How-To Capture extension in Chrome or Edge, and pin it to the toolbar.
- Click the extension icon, paste the site address shown on the Capture extension page and your key, and click Connect. Use exactly the address shown, so recordings arrive in your own Knowledge Base.
Recording:
- Click the extension, then Start recording. The icon shows a red badge with the step count.
- Do the task. Pause and Resume skip clicks you don't want, and Delete last step removes a mistake.
- Click Stop. Enter a title, pick a group, and click Send to Knowledge Base. The draft opens in a new tab.
- In the step editor, blur anything private, adjust the steps, untick Disabled and click Submit to publish.
What it records:
- Typing: only the field name, such as "Type in the Email field". It never records what you typed, and it skips password fields.
- Values already on screen: these still appear in later screenshots. That's why captures always arrive as drafts.
- Not recorded: browser pages and clicks inside embedded frames from other sites, such as payment boxes.
Keys: revoke a key on the Capture extension page and it stops working at once. Administrators see and can revoke everyone's keys. A key also stops working if its owner is deactivated or loses Create permission.
Setting up AI: saving your OpenAI API key
AI cleanup uses your own OpenAI account, so its usage is billed to you by OpenAI. Save your key once and the Clean up with AI button appears for authors. This takes an administrator about five minutes.
1. Get a key from OpenAI
- Sign in at platform.openai.com, or create an account.
- Under Billing, add a payment method or credit. Requests fail without it.
- Go to API keys, click Create new secret key, name it (for example "TruDriveSync Knowledge Base"), and copy it. OpenAI shows it only once.
2. Save it in TruDriveSync
- Go to Settings › AI Integration › OpenAI.
- Paste the key into the API key field and click Save.
3. Check it's working
Go to Knowledge Base › AI settings. A green box saying "AI cleanup is available" means you're ready. A yellow box says what's missing, with a link to the OpenAI settings.
Keeping the key safe:
- Your key stays on the server. It's never shown to staff, sent to their browsers or to the capture extension, or written to the AI log.
- To replace a key, create a new one at OpenAI, paste it into the same field, then delete the old one at OpenAI.
- If OpenAI isn't listed under Settings › AI Integration, it isn't enabled on your account. Contact support. Everything except AI cleanup works without it.
AI cleanup
Clean up with AI rewrites a How-To's steps as clear instructions. It merges or drops accidental clicks, suggests a title, intro and closing tip, and flags screenshots that may show private data.
For authors:
- In the step editor, click Clean up with AI.
- Choose Standard, which is quick and right for most guides, or Thorough, for long or complicated ones. Thorough is slower and costs more.
- Optional, when an administrator allows it: tick Include screenshots. Click any thumbnail to blur it first, then tick I have looked at these screenshots and blurred anything private.
- Click Get suggestion. The window shows Now and Suggested side by side, with merged steps, steps to remove, and private-data warnings.
- Click Apply to put the suggestion into the editor, check it over, and click Submit. Nothing is saved before Submit. The version note records "AI cleanup applied" and the model.
Without screenshots, only the title, intro, closing tip, and each step's title, note and page name are sent to OpenAI. Page addresses are never sent.
For administrators: Knowledge Base › AI settings.
|
Setting |
Default |
|---|---|
|
Offer "Clean up with AI" |
On |
|
Standard model |
gpt-6-luna |
|
With screenshots model |
gpt-6.1-terra |
|
Thorough model |
gpt-6.1-sol |
|
Allow authors to include screenshots |
Off |
|
Most screenshots per cleanup |
20 |
|
House style |
Second person, short sentences, plain language |
- Models: a changed model ID is checked with your OpenAI account when you save. One that your account can't use is refused.
- Recent AI cleanups: the list on the same page shows each run: who ran it, the article, the model, what was sent, token counts, and whether it was applied. Use it to keep an eye on your OpenAI usage.
Customer portal and FlexAcademy
Customer portal: customers see only active articles in public groups that aren't marked Internal only. Restricted and internal articles are also kept out of the staff search and the ticket article picker for staff who can't open them. Under each public article, customers see related public articles under See also. Public How-Tos also have a Download PDF box.
FlexAcademy: when you edit a lesson, pick Knowledge Base articles under Knowledge base articles. Learners see them as Reference articles under the lesson summary. Customers see only the public ones, and staff also see internal ones. An article that's linked to a lesson shows Used in training.
Troubleshooting
|
Problem |
What to do |
|---|---|
|
"The knowledge base library is still being set up" |
Reload the page once. If it stays, send the whole notice, including any "Setup problem" line, to support. |
|
No "Clean up with AI" button |
Knowledge Base › AI settings shows what's missing: the OpenAI key, or the setting is off. See Setting up AI above. |
|
"OpenAI rejected the saved key" |
The key was deleted or mistyped. Create a new one at OpenAI and save it again. |
|
"OpenAI could not do the cleanup: …" |
The text after the colon is OpenAI's own reason, often billing or quota. Check your OpenAI billing page. |
|
Extension: "The Knowledge Base was not found at this address" |
Copy the site address from the Capture extension page again. |
|
Extension: "This capture key is not valid" |
The key was revoked, or its owner lost Create permission. Create a new key. |
|
Screenshot missing on a captured step |
That page can't be captured, such as browser settings pages. The step is kept without a picture. |
|
Can't see an internal article |
Ask an administrator to give your role or user access to its group. |