Skip to content

Customization guide

You can tailor your documentation’s identity, audience, style, and update frequency to fit your product’s specific needs. Follow these steps to adjust your documentation site settings and ensure your content remains relevant to your users.

Update site identity

You can modify the display name and URL slug for your documentation project to align with your branding.

  1. Navigate to the repository settings in your dashboard.
  2. Enter a new name in the Display name field. This name identifies the project within your workspace.
  3. Review the URL slug field. This defines the unique public web address for your documentation.
  4. Observe the live preview below the slug field to see how the final URL will appear (e.g., docubot.cc/your-product-name).

Refine target audiences

Adjusting your audience selection changes the recommended document types for your project.

  1. Locate the Audiences section.
  2. Select the roles that best represent your readers: End User, Power User, Administrator, or Developer.
  3. Notice that selecting a new audience automatically updates the suggested document types.
  4. Confirm any prompts regarding document type resets if you previously made custom selections.

Select document types

You can manually include or exclude specific guides to create a documentation set that matches your product’s complexity.

  1. Scroll to the Document types list.
  2. Review the available templates grouped by quadrant, such as Tutorials, How-to guides, Explanations, and Reference.
  3. Check the boxes for the specific guides you want to publish.
  4. Monitor the selection count indicator to keep track of your total document set.

Change documentation style

Switch the overall voice and tone of your documentation by selecting a general style that fits your brand’s personality.

  1. Go to the General style section.
  2. Choose a style option using the radio buttons. For example:
    • Precision Technical: Best for exact, scan-friendly documentation for technical teams.
    • Approachable Guided: Best for warm, guided documentation for new or non-technical readers.
  3. Read the summary descriptions to understand the tone and structural rules each style applies to your content.

Configure the sync schedule

Set the cadence for automated documentation updates to ensure your help center stays aligned with your latest code changes.

  1. Find the Update frequency options.
  2. Select a cadence: Daily, Weekly, or Monthly.
  3. Choose a specific Update time using the time selector.
  4. Verify your Time zone setting to ensure the sync runs at the expected hour.
  5. If you select Weekly or Monthly, pick the specific day of the week or month for the update.

Provide advanced context

You can guide the AI generation process by providing specific scenario priorities or known issues.

  1. Open the Advanced doc inputs details section.
  2. In the Scenario priorities text area, list the specific user workflows you want the how-to guides to focus on.
  3. In the Known issues & workarounds text area, list current limitations and their temporary fixes to populate your workaround articles.
  4. Enter each item on a new line for better clarity.

Update support contacts

Configure the contact details that appear on your public “Contact and support” reference page.

  1. Navigate to your profile or workspace settings.
  2. Enter your Support email and Support phone number.
  3. Provide a Support portal URL if you use an external help desk or ticketing system.
  4. Save your settings to update the published support page automatically.

If you need assistance with customization, contact support at support@ademero.com, call 863-937-0272, or visit https://www.ademero.com.