Skip to content
DocuBot documentation

Best practices guide

DocuBot transforms your code into a structured help center. To get the most out of the AI-driven generation process, follow these recommendations for configuring your projects and guiding the content engine.

Optimizing project structure and naming

Your project configuration sets the foundation for how users find and navigate your documentation.

  • Choose descriptive slugs: Your URL slug is the public face of your documentation. Use a short, lowercase name that represents your product clearly (e.g., my-app-docs).
  • Consolidate related repositories: If your product consists of multiple services or applications, add them as sources to a single DocuBot project. This creates a unified help center where the AI can understand and document the relationships between different parts of your ecosystem.
  • Assign roles accurately: Ensure you designate the correct “Primary UI” repository. This helps the AI identify the main user experience and prioritize it during the generation of onboarding and quick-start guides.

Audience-centric documentation planning

DocuBot uses audience filters to determine which document types are most relevant.

  • Be specific with audiences: Only select the audiences that truly interact with your product. Selecting “Developer” for a product with no public API creates unnecessary technical documentation that might confuse end users.
  • Refine your doc set: After selecting audiences, review the auto-selected document types. Remove any that do not apply to your current stage of development to keep your help center focused and concise.

Grounding AI with advanced inputs

You can significantly improve the accuracy of generated content by providing context that isn’t always obvious from the code alone.

  • Define scenario priorities: Use the “Scenario priorities” field to list the top three to five tasks your users perform. This ensures the AI prioritizes these workflows in how-to guides and tutorials.
  • Document known issues: If your product has specific limitations or requires temporary workarounds, list them in the “Known issues” section. The AI uses this to build helpful troubleshooting articles.
  • Use ignore patterns: Exclude large third-party libraries, vendored code, or asset directories using glob patterns (e.g., **/ThirdParty_*/**). This reduces noise in the code bundle and allows the AI to focus on your unique logic.

Selecting the right documentation style

The general style you choose dictates the voice and tone of every page in your help center.

  • Match style to technical level: Use the Precision Technical style for developer-facing tools where exact parameters and configuration blocks are critical. Use Approachable Guided for consumer apps where a warm, supportive tone helps reduce user anxiety.
  • Stick to the Default for mixed groups: If your documentation serves both administrators and casual end users, the DocuBot Default style provides a balanced, professional tone that works for everyone.

Maintaining documentation freshness

Documentation is only useful if it stays aligned with your latest releases.

  • Schedule off-peak syncs: Set your daily or weekly sync time to occur after your team typically pushes code for the day. This ensures your docs refresh overnight and are ready for users the next morning.
  • Trigger manual syncs for major releases: When you ship a significant feature or a breaking change, use the “Rebuild documentation” button to update your help center immediately rather than waiting for the scheduled sync.

Enhancing API reference quality

DocuBot automatically detects OpenAPI and Swagger specifications to create interactive API explorers.

  • Keep specs in the repository: Ensure your latest API definitions are committed to your GitHub repository. DocuBot identifies these files and renders them using a modern, interactive viewer.
  • Provide clear titles in specs: The AI uses the title field within your OpenAPI file to name the reference section in the sidebar. Ensure this title is user-friendly.

Get help

If you need assistance configuring your documentation site or optimizing your AI inputs, contact our support team: