# Knowledge Base

Set up one or more knowledge bases, write and import articles, link videos, documents and runbooks, choose who can read each one, and turn articles into training videos.

When the same questions come in every week, a written answer people can find saves everyone time. Acme Precision keeps one knowledge base for shop staff on machine setup and another for customers on placing orders.

[Add it from the Marketplace](/tenant/?open=settings/marketplace)

## What it does

The **Knowledge Base & Support** module lets your workspace keep its own help library. Each knowledge base is a tree of sections and articles in the left navigation, with the article on the right. Keep several: one for staff, one for customers, one for partners, or one per program.

Articles can link web pages, videos, documents, other articles and runbooks, and steps can show screenshots or short clips. Each knowledge base is read in the app only, or offered to your knowledge base website.

## Set it up

1. Add the module from the Marketplace. See [Marketplace: add or remove a module](article:5bf25be1-f0e9-40e4-9ef9-70ac8532cd9b).
2. Open its Module Settings from the **⋮** on the module's sidebar row, or click **Knowledge bases** above the tree. See [Module settings and versions](article:fb7c92e4-6dcc-4ef4-80bc-1b6e7482e540).
3. Click **New knowledge base** and fill in **Name** and **What it is for**.
4. Choose the **Audience**: **Internal staff (needs Read internal knowledge bases)**, **Public** or **Partners**.
5. Choose **Who can read it**: **In the app only**, **Website, no sign-in** or **Website, with a sign-in code**. A **Sign-in code** needs at least 8 characters and can't be read back later.
6. Click **Save**, then give roles access using the table below. See [Users and roles: roles and permissions](article:888a2a90-7990-4ea5-a58e-af06f56b1bfd).

## Write an article

1. Click **Knowledge Base** in the sidebar and pick the knowledge base from the list at the top.
2. Click **Section** or **Article**.
3. Type a **Title** and a **Summary**: one sentence on what the reader can do afterwards.
4. Leave **Status** as **Draft (authors only)** until someone has checked it, or choose **Published (everyone who can read)**.
5. Write the **Text**, with `##` for headings and `1.` `2.` `3.` for steps. **How it will look** previews it.
6. Click **Save**.

On an open page, **Move** puts it under another section, and **Copy link** gives a link to paste into another article. The hint under **Text** also shows how to add a **Do it now** button that opens a screen, and a **Show me** button that asks the assistant to walk a runbook on the reader's screen.

## Import a document

1. Click **Import** above the tree.
2. Choose a Word, Markdown, HTML or text file under **Document**, or use **Or paste the text**.
3. Choose **Put it under** and whether **New articles are** drafts or published.
4. Under **When a title already exists**, choose **Update that article with the new text** or **Leave it alone and only add new ones**.
5. Click **Preview**. It lists each item as **New**, **Update**, **Same** or **Left alone**, and saves nothing.
6. Click **Load into the knowledge base**. The import either completes or changes nothing.

## Links and training videos

1. Open an article and click **Add link**.
2. Pick **Web address**, **Video**, **Document**, **Another article** or **Runbook**, and give it a **Title**.
3. For a video or document, upload the file or paste its web address. For a runbook, search in **Find a runbook** and pick one under **Runbook**. Only published runbooks from the Runbooks module are offered.
4. Click **Add link**.

Links appear under **Related material**, and a linked video gets a **Watch** button at the top.

To make training videos, open an article or section and click **Make training videos**. Fill in **Who is it for** and **Anything else the video should do**, then click **Create in Video Studio**. A section becomes a series with one draft video per article, and each script is approved in Video Studio before narration.

## Who can do what

| Permission | What it lets someone do |
| --- | --- |
| **Read the knowledge base** | Read published articles and open their links |
| **Read internal knowledge bases** | Also read knowledge bases whose audience is Internal staff |
| **Write articles** | See drafts, write articles and sections, add links, import documents, make training videos |
| **Delete articles** | Delete articles, sections and links, permanently |
| **Manage knowledge bases** | Create, change and delete knowledge bases and choose who can read each one |
| **Website: knowledge base** | For the knowledge base website's own key only, never a person |

Without **Read internal knowledge bases**, internal knowledge bases are hidden everywhere: the list, search, links, the assistant and other modules' searches.

## Ask its agent

The **Knowledge Base** assistant searches, writes and imports articles, links runbooks and sends articles to Video Studio. Try:

- "Which articles mention time tracking?"
- "Create a knowledge base section from this document."
- "Send the Getting started section to Video Studio."

It shows what an import would change and waits for your yes. See [Agent chat](article:073c6465-d85c-4364-8768-acf42a3a6a48).

## Good to know

- **Drafts stay private.** Readers and the website see published articles only.
- **Deleting a knowledge base removes everything in it**, and can't be undone.
- **The website is set up separately.** A website option offers the knowledge base to it once it is published.

## More help

Open **Help** in the module for its runbooks on each of these jobs. Related modules: Runbooks for step-by-step procedures, and Video Studio for narrated training videos. See [Module help and Show me](article:53508199-cd90-4a4c-a453-f6e5c68bdd8e).


Source: https://datavisions.ai/docs/module-guides/knowledge-base
