Use Atloria’s generation and review workflow to establish how AI-generated documentation is checked before publication. Clear review rules help you keep generated content accurate, consistent, and ready for your documentation audience.
Overview
Atloria supports a review-and-publish workflow for generated documentation. You begin in the Generation area, generate or import documentation, inspect the result in Preview, and complete the process through Review & Publish.
The available interface does not show a separate form for entering named review rules. Instead, you establish review expectations by using a consistent review process: require a preview check, verify content before publishing, and return to the review workspace when revisions are needed.
Use this process whenever you generate new documentation, regenerate content after source changes, or import existing documentation that must meet your organization’s quality standards.
📷 Screenshot pending: The Generation screen showing options to generate documentation, preview results, and begin Review & Publish.
Prerequisites
Before you start, make sure you have:
- Access to the project version for which documentation will be generated or reviewed.
- Documentation ready to generate, or existing documentation ready to import.
- Agreed review expectations for accuracy, terminology, completeness, and approval responsibility.
- A designated reviewer who can verify generated content before it is published.
- Time to wait for the generation process to complete if Generation Running is displayed.
Step-by-Step Instructions
-
Open the project version that contains the documentation you want to review.
-
Select Generation to open the documentation generation workspace.
-
Choose Generate Documentation → when you want Atloria to create documentation from the available project content.
-
Select Or import existing documentation when you want to review documentation that was created outside the generation workflow.
-
Wait for Generation Running to finish before beginning the review.
-
Select Cancel Generation if the generation was started with the wrong content or should not continue.
-
Open Preview after generation is complete.
-
Review the generated content for factual accuracy.
-
Review the generated content for required sections and expected level of detail.
-
Review terminology, names, and descriptions for consistency with your organization’s standards.
-
Select Copy when you need to copy generated text for comparison, editing, or review outside the preview.
-
Select Review & Publish when the content is ready for formal review.
-
Check Review Summary to confirm the documentation is ready for the next approval decision.
-
Select Back to Review when you need to return to the review workspace and continue checking the content.
-
Select View Your Documentation → only after the required review checks are complete.
📷 Screenshot pending: The Review Summary area with Back to Review and View Your Documentation actions.
Tips and Best Practices
-
Define your review expectations before starting generation. For example, decide who checks technical accuracy, who checks writing quality, and who gives final publication approval.
-
Treat generated content as a draft until it has been reviewed. Use Preview to inspect the content before moving forward with Review & Publish.
-
Review each generation separately. A new generation can produce different wording, structure, or coverage, even when it relates to the same documentation area.
-
Use Back to Review rather than publishing immediately when you identify missing details, incorrect statements, or content that does not meet your team’s standards.
-
Establish a minimum review checklist for every document. Your checklist can include:
- Technical facts are correct.
- Important user tasks are included.
- Terms match the product interface and internal terminology.
- Content is understandable for the intended audience.
- Sensitive, outdated, or unverified information is removed.
-
Do not rely on generation status alone as an approval signal. Generation Running indicates that content is being created; it does not indicate that the content has been reviewed or approved.
-
Use the Preview action before sharing or exporting documentation. This helps you identify issues while the content is still in the review workflow.
Related Pages
- Generate Documentation
- Review and Publish Generated Documentation
- Preview Generated Documentation
- Export Documentation
- Share a Preview Link
Troubleshooting
You cannot find a place to enter review rules
Atloria’s visible generation and review actions do not include a dedicated review-rules form. Establish review rules as a team checklist and apply that checklist during Preview and Review & Publish.
Generation is still in progress
If Generation Running is displayed, wait for the process to finish before reviewing the output. Select Cancel Generation only when you need to stop the current generation attempt.
The generated documentation is not ready to publish
Select Back to Review from Review Summary. Recheck the content in Preview, compare it with your review expectations, and proceed to View Your Documentation → only after the required checks are complete.
Was this page helpful?