Glossary

Terms used in DocSpade, in alphabetical order.

Admin. An organization role. Admins create and configure spaces and knowledge bases and manage people. They can do everything an editor or publisher can do, everywhere in the organization.

AI readiness. A review that checks whether an article is organized so that an assistant or search tool can find and use the right part of it. See Reviewing your writing.

Alt text. A short description of an image for people who cannot see it. Screen readers read it aloud.

Article. One page of documentation. It has a title and a slug.

Article type. The kind of article you are writing, such as a quickstart, a how-to guide or a reference page. Choosing one adds checks for the structure that kind of article needs.

Aside. A highlighted box in an article. The types are note, tip, caution and danger.

Ask AI. A feature that lets readers ask a question in their own words and get an answer taken from your published documentation, with links to its sources.

Block. One piece of shared content.

Card. A tile on a home page that links readers to articles. Knowledge base home pages have cards that you create. The organization home page shows a card for each published knowledge base.

Divider. A line in the navigation that separates sections of the menu.

Draft. Your private copy of an article. It is not included when the site is published.

Editor. A role on a knowledge base. Editors can write and edit articles and arrange the navigation.

Finding. One result of a review, such as a word to change or a heading out of order. A finding may include a recommended change.

Group. A heading in the navigation that holds other items.

Guest. An organization role for an outside collaborator, who can reach only what they have been given.

Home page. The first page of a site. An organization has a home page that lists its published knowledge bases, and each knowledge base has its own.

Knowledge base. One documentation site: a set of articles with a navigation menu, a look and a home page. It is what you publish.

Member. An organization role for a teammate who works in the spaces and knowledge bases they have been given.

Navigation. The menu readers use to move around a site. It is a tree of groups, articles, links and dividers.

Organization. Your company or team. It contains spaces, and owns the people and sites.

Owner. An organization role. Owners can do everything an admin can, and they run the organization.

Persona. In Ask AI settings, a short description of who the assistant is and how it presents itself.

Publish (an article). To save an article so that it is ready for the next site update, by choosing Publish in the Save menu. Readers do not see it until the site is published.

Publish (a site). To build a new version of a knowledge base’s site and make it live, with Publish site.

Publisher. A role on a knowledge base. Publishers can do everything an editor can, and publish the site.

Recommended change. A specific fix that a style finding offers, which you can accept with the OK button.

Retired. The status of a shared content block that can no longer be inserted into articles.

Review. A check of an article for style, accessibility or AI readiness. A review gives advice and never blocks saving or publishing.

Shared content. Text you write once and insert into many articles. It belongs to a space. See Shared content.

Site. The published documentation website for a knowledge base.

Slug. The short name that makes up part of a web address, such as get-started. An article’s slug stays the same when you change its title. Organizations, spaces and knowledge bases also have slugs.

Space. A group of related knowledge bases. A space also sets the default style guides for the knowledge bases in it, and holds their shared content.

Style guide. A set of writing rules that a style review checks against. DocSpade includes Google, Microsoft and Healthcare.

Tabs. A block that shows one panel of content at a time, with labels the reader clicks to switch.

Theme. The colors and overall look of a published site.

Tone. How Ask AI answers sound: professional, friendly, concise or formal.

Viewer. A role on a knowledge base. Viewers can read it.