Glossary

This glossary defines the key terms and concepts you encounter while using DocuBot. Understanding these terms helps you better manage your documentation projects and configure your synchronization settings.

Core Concepts

Documentation Style A selectable framework that determines the visual layout, linguistic tone, and information priority of your generated documentation. You choose a style—such as DocuBot Default or Precision Technical—to ensure your help center matches your brand’s voice.

Quadrant A classification system based on the Diátaxis framework used to structure your content. DocuBot organizes pages into four quadrants: Tutorials (learning-oriented), How-to Guides (task-oriented), Explanation (understanding-oriented), and Reference (information-oriented).

Slug The unique URL identifier for your documentation site. For example, if your slug is my-product, your documentation is published at docubot.cc/my-product. Slugs are globally unique and consist of lowercase letters, numbers, and dashes.

Sync and Generation

Manual Sync A documentation update that you trigger yourself from the dashboard. This allows you to see changes immediately after a code push. Manual syncs are subject to daily limits based on your account type.

Scheduled Sync An automated update process that runs based on your defined frequency. You can configure DocuBot to refresh your documentation on a daily, weekly, or monthly basis at a specific local time.

Sync Job A specific instance of the DocuBot engine checking your repository for code changes and regenerating the documentation site. You can monitor the progress of active sync jobs directly on your repository cards.

Technical References

Bundle An optimized collection of your repository’s source code. DocuBot packages your files into this format so the AI generator can analyze the entire context of your project accurately without missing cross-references.

GitHub OAuth A secure authorization method that connects your GitHub account to DocuBot. This connection is required if you want DocuBot to access and document private repositories.

Scalar Reference The interactive, modern API viewer used to render your OpenAPI and Swagger specifications. It provides a “Try It Out” interface and code samples directly within your documentation site.

Audience and Roles

Audience The target reader group for your documentation. You select audiences like End User, Administrator, Power User, or Developer to help DocuBot determine which types of documents (such as Quick Start Guides or API References) are most relevant to generate.

Primary UI A role assigned to the repository that represents the main user experience of your product. When you connect multiple repositories to a single documentation site, the Primary UI acts as the foundational source for the project’s conceptual overviews.

For further assistance or to suggest additions to this glossary, please contact support at support@ademero.com or visit https://www.ademero.com.