Skip to content
DocuBot documentation

Key concepts

DocuBot transforms your source code into a structured help center using artificial intelligence. To get the most out of the platform, you should understand the core concepts that govern how your documentation is planned, written, and published.

Documentation styles

Documentation styles act as a tonal and structural overlay for your entire help center. Instead of a one-size-fits-all approach, you choose a style that matches your brand and your users’ technical level.

When you select a style, DocuBot adjusts the voice and attitude of the generated content. For example:

  • DocuBot Default: Provides a balanced, friendly, and clear tone suitable for a wide range of users.
  • Precision Technical: Focuses on accuracy and scanability with a neutral, confident tone designed for developers and administrators.
  • Approachable Guided: Uses warm, supportive language to help non-technical users build confidence.

Audience-driven document types

DocuBot uses your target audiences to determine which types of documents your help center needs. When you select an audience role, the system automatically maps it to a preset of document types.

  • End Users: Typically receive Quick Start guides and core scenario how-tos.
  • Developers: Receive API references, authentication guides, and “Hello World” examples.
  • Administrators: Receive installation guides, user management instructions, and security overviews.

You can always customize these presets by adding or removing specific document types to fit your product’s unique requirements.

Repository synchronization

Synchronization is the mechanism that keeps your documentation aligned with your latest code changes. Because DocuBot analyzes your repository to generate content, regular syncs ensure that your help center never falls behind your feature releases.

You can configure the sync frequency to meet your team’s needs:

  • Scheduled Syncs: Set your documentation to refresh on a daily, weekly, or monthly schedule at a specific local time.
  • Manual Syncs: Trigger an immediate update whenever you push a major change that requires instant documentation updates.

Static site generation

Every documentation site produced by DocuBot is published as a static help center. This means your documentation consists of high-performance HTML pages rather than content generated on the fly.

Static generation provides several key benefits:

  • SEO Optimization: Search engines can easily crawl and index your documentation, making it easier for users to find answers via web search.
  • Clean URLs: Your docs use simple, human-readable URL slugs (e.g., docubot.cc/your-product/guide/intro) that are easy to share.
  • Reliability: Because the pages are pre-rendered, your help center remains fast and accessible regardless of repository activity.

Get support

If you have questions about these concepts or need help configuring your documentation site, please reach out to our support team: