Glossary

This glossary defines the essential terms and concepts you encounter while using DocuBot. Use this reference to understand how the platform organizes, generates, and delivers your documentation.

Core platform terms

Documentation site The public-facing help center generated by DocuBot. It hosts your guides, references, and tutorials at a dedicated web address.

Repository source A GitHub repository you connect to a documentation site. DocuBot analyzes the code and metadata within these sources to generate content.

URL slug The unique identifier used in your documentation site’s web address. For example, in docubot.cc/my-product, “my-product” is the slug.

Workspace Your private dashboard where you manage your documentation sites, repository connections, and account preferences.

Configuration and customization

Audience The target reader group for your documentation. You can select from End User, Power User, Administrator, or Developer. Your selection determines the default set of document types DocuBot generates.

Document type A specific template or guide format designed for a particular purpose, such as a Quick Start Guide, Troubleshooting Guide, or API Reference.

General style The overall tone, voice, and structural rules applied to your entire documentation set. Options include “Precision Technical” for exactness or “Approachable Guided” for a warmer, simpler tone.

Known issues Custom inputs you provide regarding documented bugs or limitations. DocuBot uses these to generate specific workaround and knowledge base articles.

Scenario focus Specific user workflows or tasks you prioritize. Providing these inputs helps the AI tailor how-to guides to your most important use cases.

Automation and delivery

OpenAPI reference An interactive, searchable API viewer rendered automatically from Swagger or OpenAPI specifications found in your repository.

Role detection The automated process where DocuBot identifies the purpose of a repository source, such as a “Primary UI” for your main application or “API Reference” for your backend services.

Static output Documentation delivered as pre-rendered HTML files. This ensures your help center is fast, reliable, and optimized for search engines (SEO).

Sync schedule The automated frequency at which DocuBot refreshes your documentation. You can configure this to run daily, weekly, or monthly at a specific time.

Support and integration

GitHub OAuth The secure authorization protocol you use to grant DocuBot access to your GitHub account. This is required to generate documentation from private repositories.

PDF export A downloadable version of your documentation site. It includes an automated table of contents and bookmarks for easy offline navigation.

Support contacts The specific email addresses, portal URLs, and phone numbers you configure in your settings. These details are automatically embedded into your “Contact and support” pages. If you need assistance with DocuBot itself, you can reach out to support@ademero.com or visit https://www.ademero.com.