When product information changes, you can request an updated version of your AI-generated documentation. Refreshing your documentation helps keep User Guides and User Manuals aligned with the current product experience.
Overview
Atloria generates documentation based on the product information available during the generation process. When your product screens, workflows, terminology, or documentation requirements change, you should review the generated content and request updates rather than continuing to use an outdated version.
Use this process when you need to revise generated User Guides, User Manuals, or other generated documentation. For example, you may need an update after adding a product surface, changing a user flow, or correcting content that no longer reflects how users interact with the product.
The update process begins from your documentation area. You can review the current generated documentation, submit a change request, monitor the generation status, and save the updated result when it is ready.
📷 Screenshot pending: The documentation area showing generated documentation and available actions.
Prerequisites
Before you request updated documentation, make sure you have the following:
- Access to the relevant project and its documentation workspace.
- Documentation that has already been generated, indicated by the Generated status or available generated content.
- A clear list of product changes that affect the documentation.
- The ability to describe the requested updates using ✎ Request Changes.
- Time to wait for the 4. Generation Running stage to finish before reviewing the refreshed content.
Step-by-Step Instructions
-
Open the project that contains the documentation you want to update.
-
Select User Docs to open the project’s documentation area.
-
Select User Guides if you are updating end-user guidance.
-
Select 📋 User Manuals if you are updating manual-style documentation for users.
-
Review the currently Generated documentation before requesting changes.
-
Identify the sections that no longer match the product, such as changed user flows, renamed product areas, or newly available product surfaces.
-
Select ✎ Request Changes.
-
Enter a clear description of the product information that has changed.
-
Specify which documentation content should be updated, such as a User Guide, a User Manual, or a particular workflow.
-
Include the current user-facing terms in your request so the refreshed documentation uses the correct labels.
-
Submit the change request to begin the update process.
-
Select Generation to view the documentation generation progress.
-
Confirm that the status shows 4. Generation Running while Atloria is preparing the updated documentation.
-
Wait for generation to complete before reviewing the refreshed content.
-
Select User Docs again after generation finishes.
-
Open the updated User Guides or 📋 User Manuals content.
-
Review the refreshed documentation for accuracy, completeness, and user-facing terminology.
-
Select Save Changes after you finish reviewing or editing the updated documentation.
📷 Screenshot pending: The generated documentation view with the “✎ Request Changes” action available.
Tips and Best Practices
-
Request updates whenever product behavior changes, not only when text labels change. A revised workflow can affect several documentation sections even when the screen names remain the same.
-
Describe changes from the user’s perspective. For example, explain that users now select a different menu item, see a new status, or follow a revised sequence of actions.
-
Include exact visible labels in your request. If the product uses labels such as User Docs, User Guides, or Product, use those terms so the regenerated content matches the interface.
-
Review both documentation types when applicable. Atloria can present User Manuals and other documentation side by side, so a change that affects end users may require updates in more than one documentation area.
-
Use the generation status to avoid reviewing too early. While 4. Generation Running is displayed, the updated content is still being prepared.
-
Do not use ■ Cancel Generation unless you need to stop the current update. If you cancel generation, review your requested changes before starting a new request.
-
Save any edits you make after reviewing the refreshed documentation. Select Save Changes so your accepted updates are retained.
📷 Screenshot pending: The Generation view displaying the “4. Generation Running” status and the “■ Cancel Generation” action.
Related Pages
- Generate Documentation
- Request Changes to Generated Documentation
- Review User Guides
- Manage User Manuals
- Export Documentation
Troubleshooting
The updated documentation is not available yet
Check Generation and look for 4. Generation Running. The refreshed documentation is not ready for review until the generation process finishes. Return to User Docs after the running status is no longer displayed.
You need to stop an update request
Select ■ Cancel Generation from the generation view. After cancelling, review the product changes you want documented and submit a new request using ✎ Request Changes when you are ready.
The refreshed documentation still does not reflect the product change
Select ✎ Request Changes again and provide more specific information. Include the affected documentation type, the changed product area, the exact user-facing labels, and the expected user workflow. Then monitor Generation and review the new generated result.
Was this page helpful?