An empty page tree is the hardest part of starting a Knowledgebase. Describe to Set Up takes a description of what the Knowledgebase is for and suggests a structure of pages. Nothing is written until you have reviewed it.
Before You Start
- Describe to Set Up runs on built-in AI, included, up to 10 suggestions a person a day, or on your team's own key if it adds one. On a server with no built-in AI and no key, the dialog explains this and offers Open AI Settings. See AI Settings.
- You need to be signed in, as an Editor of the whole Knowledgebase.
- It is not offered for a Knowledgebase kept Offline.
Set Up an Empty Knowledgebase
Press Describe to Set Up in the sidebar, above New Page. It shows while the Knowledgebase is empty: at most three pages, none with any writing beyond a title. On a phone it is in the Pages sheet.
Under What Is This Knowledgebase For?, describe it in your own words, in 20 to 1,000 characters. The three chips under the field (Engineering Handbook, Customer Support, Company Handbook) fill it with an example you can edit.
Press Suggest a Structure. In a few seconds the dialog shows a tree of up to 30 pages, at most 3 levels deep, each with a title and one line on what belongs there.
Review it. Untick a page you do not want (its subpages are unticked with it), and press a title to rename it. Above the pages, a name is suggested for the Knowledgebase too; it is offered only while the Knowledgebase is still called "Untitled Knowledgebase". Try Again goes back to your description.
Press Create 14 Pages (the number follows your ticks). The pages are made in order, twenty at a time, and the dialog closes on the first new page.
Each new page holds its title, its one line in italics as the first paragraph, and its suggested headings with an empty paragraph under each. If the Knowledgebase still has its untouched Start Here page, that page becomes the first page of the structure.
Add Pages to a Knowledgebase Later
Once a Knowledgebase holds writing, the button leaves the sidebar and Describe to Add Pages takes over: open the command palette, type "Describe to Add Pages" and press Enter. It asks What Pages Should Be Added?, is told the titles of the pages you already have, and adds the new pages under the page you have open. Nothing that exists is changed.
Who Can Use It
| Action | Editor | Participant | Viewer |
|---|---|---|---|
| See and use Describe to Set Up | Yes | No | No |
| See the pages it made | Yes | Yes | Yes |
Good to Know
- Undo takes back the last twenty pages made, not the whole structure. The pages can also be deleted from the page tree.
- New pages are Never Verified and have no owner. Nothing here verifies anything.
- A structure that would pass the Knowledgebase's 500 pages or 8 levels says so under These Pages Do Not Fit and creates nothing.
- Limits: 5 suggestions a person an hour, and 20 a Knowledgebase a day. Past either, the dialog says which and when to try again; you can still add pages by hand.
- Your description is sent to your team's AI provider to make the suggestion. It is not kept in telemetry.
- If no usable structure comes back, the dialog says Could Not Suggest a Structure and offers Try Again. Other failures read as they do in Ask: see Ask Is Not Answering.
Was this article helpful?
Still need help?
Try Troubleshooting, or tell us what you were trying to do.