Conceptual overview

About DocuBot

DocuBot is a documentation engine that bridges the gap between technical source code and user-friendly help centers. It transforms your GitHub repositories into living, structured documentation sites that stay aligned with your latest code updates. Instead of manually writing and maintaining static pages, you use DocuBot to generate high-quality, searchable documentation tailored to specific audiences.

The DocuBot mental model

Most documentation tools focus on simple file-to-page conversion. DocuBot uses an audience-first philosophy. You start by identifying who you serve—such as end users, administrators, or developers—and the system maps those audiences to the specific document types they need.

By blending a universal voice with specialized document-type rules, DocuBot ensures that every page feels purposeful and cohesive. This approach reduces factual drift and ensures that your documentation reads as if a dedicated team wrote it, even as your codebase evolves.

Key concepts

To manage your documentation effectively, you should understand the three pillars of the DocuBot system:

• Audiences: These define who the documentation is for. You can select from End User, Power User, Administrator, and Developer. Your selection determines the default set of documents DocuBot generates.
• Document types: These are specific templates designed for different tasks. Examples include Quick Start Guides for onboarding, Troubleshooting Guides for resolving issues, and API References for technical integrations.
• General styles: These control the overall tone and voice of your documentation. You can choose styles like “Precision Technical” for exact, scan-friendly data or “Approachable Guided” for warm, step-by-step instructions.

How it fits into your workflow

DocuBot integrates directly into your existing development lifecycle to keep your help center current.

1. Connect sources: You connect one or more GitHub repositories to a single product documentation site. This allows you to aggregate information from multiple apps or services into one centralized location.
2. Configure preferences: You define your target audiences, refine the list of document types, and select a general style that matches your brand’s voice.
3. Automated synchronization: You set a sync schedule—daily, weekly, or monthly—at a specific local time. DocuBot automatically pulls the latest code, regenerates the content, and publishes the updates.
4. Manual overrides: You can provide custom inputs, such as specific scenario focuses or known issues, to prioritize certain workflows or workarounds in the generated guides.

Why static documentation matters

DocuBot produces static HTML output, which offers several advantages for your team and your users:

• Performance and SEO: Static pages load instantly and are highly visible to search engines, making it easier for users to find answers through external search.
• Shareability: Clean, SEO-friendly routes (URLs) allow your support team to share specific links with customers confidently.
• Interactive API references: If your repository contains OpenAPI or Swagger specifications, DocuBot renders them in a modern, interactive viewer for external developers.
• Offline access: You can export your entire documentation set as a professional PDF, complete with an automatic table of contents and bookmarks.

If you need assistance setting up your workspace or have questions about the documentation engine, contact support at support@ademero.com or visit https://www.ademero.com.