Publishing makes approved documentation available to the people who need it, such as end users or technical teams. This page explains how to publish a documentation version and confirm that the correct audience can view it.
Overview
Atloria supports separate documentation experiences for different audiences. User Docs is intended for user-facing guides and manuals, while Technical Docs is intended for technical documentation. Publishing lets you make the appropriate approved content available through the published documentation experience.
Before documentation is available to readers, it must be approved and published. During the publishing process, you review the documentation version, choose the audience experience that applies to the content, and use the publishing controls to make that version live.
After publishing, the documentation is marked Published and you can use View Published Docs to check the reader-facing result. If you later need to remove the content from reader access, use Unpublish.
📷 Screenshot pending: Documentation publishing area showing Review & Publish, Publish Version 4, View Published Docs, and Unpublish controls.
Prerequisites
Before you start, make sure that:
- You have access to the project that contains the documentation.
- The documentation content has been generated, imported, or written.
- The documentation is ready for review.
- The version you want to release has been approved, or you have permission to use ✓ Approve & Publish.
- You know whether the documentation is intended for the User Docs or Technical Docs audience.
- You have reviewed the documentation for accuracy, audience-appropriate language, and complete navigation.
Step-by-Step Instructions
-
Open the project that contains the documentation you want to publish.
-
Select User Docs when you are publishing guides, manuals, or other end-user documentation.
-
Select Technical Docs when you are publishing technical documentation for developers or other technical readers.
-
Open Review & Publish to review the documentation before making it available to readers.
-
Select the documentation audience that matches your content, such as User Guides for user-facing material or Technical for technical material.
-
Review the documentation version shown in the publishing area.
-
Select Publish Version 4 to publish the displayed version when that is the version you intend to release.
-
Select ✓ Approve & Publish if the version still requires approval and you are authorized to approve it.
-
Select Publish to make the approved documentation available to the selected audience.
-
Confirm that the documentation shows the Published status.
-
Select View Published Docs to open the reader-facing published documentation.
-
Review the published page as a reader to confirm that the correct content and audience experience are displayed.
📷 Screenshot pending: Published documentation opened through the View Published Docs action, showing the reader-facing audience experience.
Tips and Best Practices
-
Publish user-facing content through User Docs and technical reference material through Technical Docs. Keeping these audiences separate helps readers find documentation written for their needs.
-
Use Review & Publish before every release. This gives you an opportunity to verify that the documentation is complete and appropriate before readers can access it.
-
Use the version-specific button, such as Publish Version 4, carefully. Confirm that the displayed version is the release you want to make live before selecting it.
-
Check the published result with View Published Docs immediately after publishing. This is the best way to verify the reader experience, including the selected audience and visible documentation content.
-
If your documentation has not yet been created in Atloria, use Or import existing documentation before beginning the review and publishing process.
-
If you need to distribute documentation outside the published reader experience, consider Export Documentation after confirming that the correct version is published.
-
Use Unpublish only when the published documentation should no longer be available to readers. After unpublishing, verify that readers can no longer access the version you removed.
Related Pages
- Create User Manuals
- Generate Technical Documentation
- Review Documentation Before Publishing
- Manage Published Documentation
- Export Documentation
- Brand Your Published Documentation
Troubleshooting
The Publish button is not available
The documentation may not be ready for release or may still need approval. Open Review & Publish, review the version, and use ✓ Approve & Publish if you have the required permission.
The wrong documentation is visible to readers
Check whether you published through User Docs or Technical Docs. Open View Published Docs to confirm the reader-facing result. If the wrong version or audience is live, use Unpublish, then return to the correct documentation area and publish the intended version.
I need to remove documentation from public reader access
Open the published documentation controls and select Unpublish. Then use View Published Docs or the published documentation navigation to confirm that the removed version is no longer presented as Published.
Was this page helpful?