Skip to content
DocuBot documentation

Best practices guide

High-quality documentation depends on how you configure your DocuBot workspace. By aligning your repository settings, audience selections, and style choices with your actual product structure, you ensure that the generated help center is accurate, findable, and useful for your readers.

Optimizing repository roles

When your product spans multiple GitHub repositories, assigning the correct role to each source is the most important step for high-quality generation. These roles provide the necessary context for the AI to understand how different parts of your codebase relate to each other.

  • Primary UI: Assign this role to your main application. DocuBot uses this repository as the anchor for your documentation, prioritizing its features and workflows in the generated guides.
  • UI App: Use this for secondary experiences, such as an admin console, a mobile app, or a desktop client that complements the primary application.
  • API Reference: Assign this to repositories that contain your OpenAPI or Swagger specifications. This ensures your interactive API documentation is correctly rendered and linked.
  • Reference: Use this for supporting libraries or non-UI repositories that provide essential background information but aren’t the main focus of user workflows.

Effective audience and doc type selection

DocuBot uses your selected audiences to auto-select a preset of document types. While these presets are a great starting point, you should refine them to match your specific user base.

  • Avoid information overload: Only select audiences that actually exist for your product. For example, if you don’t offer a public API, deselecting the “Developer” audience keeps your documentation site focused and prevents the generation of empty reference sections.
  • Customize the list: You can add or remove specific document types after selecting your audiences. If a specific guide like “Keyboard shortcuts” isn’t relevant to your app, remove it to keep your sidebar clean.
  • Mind the reset: Be aware that changing your audience selection after you have customized your document types will reset the list to the default preset for those audiences.

Leveraging advanced doc inputs

The “Advanced doc inputs” section in your repository settings allows you to provide specific context that the AI cannot always infer from code alone.

  • Scenario Focus: Use this area to list the specific user workflows you care about most. Listing scenarios like “How to invite a team member” or “How to export a report” ensures these tasks are prioritized in your How-to guides.
  • Known Issues: Documenting known limitations or temporary bugs here allows DocuBot to generate helpful workaround articles and KB entries, reducing the burden on your support team.
  • Support Contacts: Ensure your workspace profile includes your support email, portal URL, and phone number. DocuBot automatically injects these details into the “Contact and support” page so users know exactly how to get help.

Maintaining documentation freshness

Your documentation is only as good as its last update. Configure your sync schedule to balance accuracy with your team’s development velocity.

  • Align with deployments: Set your sync time to occur shortly after your team typically finishes their daily or weekly deployments. This ensures your docs reflect the latest code changes.
  • Frequency selection: Use daily syncs for rapidly evolving products. For stable projects, a weekly or monthly sync may be sufficient.
  • Manual updates: If you make a major change and need the docs updated immediately, use the “Rebuild documentation” button on your repository card. Note that manual syncs are subject to daily limits.

Style selection for your brand

The general style you choose controls the voice and tone of every page in your documentation site.

  • Precision Technical: Best for developer-focused products or complex administrative tools where exact values, constraints, and structured tables are more important than narrative.
  • Approachable Guided: Ideal for non-technical end users. This style uses warm, supportive language and focuses on quick wins and simple, single-action steps.
  • DocuBot Default: A balanced choice for products with a mixed audience. it provides clear, direct, and professional guidance that works well for both beginners and power users.

If you need assistance optimizing your documentation setup, contact our support team at support@ademero.com, visit https://www.ademero.com, or call 863-937-0272.