This page explains how the audience slug in a published documentation link determines which audience’s documentation visitors see. Using the correct audience slug helps you direct each group—such as customers, administrators, or technical users—to the intended documentation experience.
Overview
When you publish documentation, Atloria uses the audience slug in the public documentation address to identify the audience being viewed. The audience slug is the audience-specific part of the published link. It appears after the main documentation or project identifier and before an individual document name, when a document is opened.
This audience selection is especially important when the same project has documentation for different readers. For example, you may publish User Guides for end users and Technical Docs for developers. Each published audience should use its own audience slug so that visitors open the correct collection of content.
You normally use an audience slug when sharing a documentation link, adding a link to a help center, or verifying that publishing has been configured for the right reader group. If the audience slug is wrong or missing, visitors may see a different audience’s documentation, a higher-level documentation page, or no matching published content.
📷 Screenshot pending: The Publishing area showing published documentation options and an audience-specific public link.
Prerequisites
Before you configure or use an audience slug, make sure you have the following:
- Access to the relevant Atloria project.
- Documentation created for the audience you want to publish.
- Permission to view or manage the project’s publishing settings.
- A published documentation collection, or content ready to publish.
- The intended audience name and its assigned slug.
- A browser window available to test the published documentation link.
Step-by-Step Instructions
-
Open the Atloria project that contains the documentation you want to publish.
-
Select Technical Docs if you are working with developer-facing or technical documentation.
-
Select User Guides if you are working with end-user documentation or help-center content.
-
Open the Publishing area for the documentation type you selected.
-
Review the published audience options shown in the Publishing area.
-
Identify the audience you want visitors to see when they open the shared link.
-
Locate the audience slug associated with that audience in the publishing details or published link.
-
Copy the published documentation link for the selected audience.
-
Confirm that the audience slug appears in the copied link between the main documentation identifier and any individual document identifier.
-
Open the copied link in a new browser tab.
-
Verify that the documentation displayed in the new tab is written for the intended audience.
-
Open an individual document from the audience’s documentation list.
-
Confirm that the audience slug remains part of the address when the individual document opens.
-
Share the audience-specific link with the intended readers.
-
Return to Publishing if the link opens the wrong documentation collection.
-
Select the correct audience’s published link before copying or distributing it again.
📷 Screenshot pending: A published documentation link with the audience slug visually identified between the main documentation identifier and the document name.
Tips and Best Practices
Use one stable, recognizable slug per audience. A short identifier based on the audience’s purpose is easier to recognize when you review or share links. For example, ensure that the slug clearly distinguishes a user-focused audience from a technical audience rather than relying on similarly named audiences.
Always test the complete published link after copying it. The audience slug is part of the audience selection, so a link that stops before the audience portion may open a general documentation page instead of the intended audience’s content.
Keep audience links separate when you publish multiple documentation types. User Guides and Technical Docs may serve different readers even when they describe the same product or project. Share the audience-specific link that matches the reader’s needs.
When linking directly to a specific document, verify both the audience and the document after opening the link. An individual document link includes the audience context, so the same document name can lead to different content depending on the audience slug in the published address.
Use the Publishing area as the source for links you distribute. This reduces the chance of manually editing a link and accidentally removing or changing the audience slug.
If you are preparing documentation for a new project, use Configure → to complete available project setup tasks before distributing publishing links. You can also use Generate Documentation → when documentation still needs to be generated before publishing.
Related Pages
- Publish Technical Documentation
- Create and Organize User Guides
- Generate Documentation
- Export Documentation
- Configure CI/CD
- Manage Documentation Styles
Troubleshooting
The link opens the wrong documentation audience
Return to Publishing and copy the link for the intended audience again. Compare the audience slug in the new link with the link you previously shared. Do not reuse a link copied from another audience’s publishing entry.
The link opens a general documentation page instead of a specific audience
Check whether the audience slug is present in the link. A general documentation address may not include the audience-specific segment. Copy the complete published link from the audience’s Publishing entry and test it in a new browser tab.
An individual document does not appear for the selected audience
Open the audience’s main published documentation link first and verify that the document is listed there. If it is not available, review the audience’s published documentation and confirm that the document belongs to the intended User Guides or Technical Docs collection before sharing a direct link.
Was this page helpful?