Work
All guides

Guide // Knowledge

How to build a project knowledge base

You'll have a teamspace with a tree of nested documents that link to people, issues and each other, plus a drive for the project's files.

For
Project leads and anyone documenting a team's work
Time
About 20 min
Uses
Teamspaces · Nested documents · Mentions and backlinks

Before you start

  • Members with the User role or above can create teamspaces, documents and drives.
  • Teamspace owners can change the teamspace's settings; drive owners can change the drive's settings.
  • People need to be in the teamspace to open its documents.

Steps

  1. Create a teamspace for the project

    In Documents, click the arrow next to Create document and choose Create teamspace. Type a Teamspace title, add Members, turn on Make private if only members should see it, and click Create.

    In the user guide
  2. Create the top-level documents

    Click Create document, check the teamspace chip, choose No parent document in the parent chip, type a title and click Create. You can also ask Maxima to write a document for you.

    In the user guide
  3. Nest pages under them

    Hover a document in the navigator and click + to create a page inside it. To reorganize, drop a document on the middle of another one, or use Move and pick a new parent document.

    In the user guide
  4. Structure each page

    Type / on a new line for headings, lists, Action items, tables, code blocks and diagrams. Headings appear in the page's table of contents.

    In the user guide
  5. Link pages, people and issues with mentions

    Type @ and pick from Employees, Documents, Meeting minutes, Cards or Issues. A mentioned person is notified, and an issue mention shows its ID and title.

    In the user guide
  6. Check backlinks

    Click Backlinks at the top right of a document to see every comment and document that mentions it. Use it to find pages that depend on the one you're changing.

    In the user guide
  7. Keep files in a drive and link to them

    Open a drive for the project and click Upload files for PDFs, exports and designs. Use Copy link on a file and add it to a document with Link.

    In the user guide

Try it in your workspace.

Or ask Maxima to do it with you.