What is DocSpade

DocSpade is a place to write your documentation, check its quality, publish it as a website, and let your readers ask questions of it in plain language.

What it does for you

• Helps you write well. Review any article against writing style guides, accessibility rules and checks that make it easier for assistants and search tools to use.
• Keeps publishing under your control. Saving never changes your live site. You publish when you are ready, and until the new version is ready your readers keep seeing the old one.
• Gives readers answers, not just search. Ask AI answers questions from your published documentation and shows the pages it used.
• Keeps teams organized. Documentation is grouped into spaces and knowledge bases, and each person has a role that decides what they can do.

The idea in one picture

Organization
`-- Space
    `-- Knowledge base   <- one documentation site
        `-- Article

Your organization contains spaces. A space contains knowledge bases, and each knowledge base is one documentation site made of articles. See How content is organized.

How you work with it

1. Set up. Create your organization, then a space and a knowledge base.
2. Write. Create articles, arrange them in the navigation, and add images, notes and tabs.
3. Review. Check each article for style, accessibility and readiness for AI, and accept the recommended changes you agree with.
4. Save. Keep work in progress as a private draft, then save the article for publishing when it is ready.
5. Publish. Publish the site. Your readers see it at your organization’s web address.
6. Answer questions. Turn on Ask AI so readers can ask questions of your documentation.

For a guided first run, follow the tutorial: Publish your first documentation site.

Who it is for

• Writers and editors who create and improve articles.
• Publishers who decide when a site goes live.
• Admins and owners who set up spaces and knowledge bases and manage people.
• Readers, who use the published site and can ask it questions.

Where to go next

• Features: everything DocSpade can do, and where to read about each part
• Drafts and publishing: how saving and publishing differ
• Glossary: the terms used in this guide