Batch screenshot processing prepares multiple application views for use in generated visual documentation. Understanding this process helps you monitor generation activity, locate the resulting screenshots, and review the source material used to create documentation.
Overview
Batch screenshot processing is part of Atloria’s documentation generation workflow. Rather than handling one screen at a time, the process gathers screenshots associated with a documentation generation and makes them available for review and management.
You typically use this workflow when you are generating documentation for a project or version that includes visual guidance. During generation, Atloria can show that work is in progress through the 4. Generation Running stage. After generation, you can use Manage Screenshots → to review the screenshots associated with the generated documentation.
Screenshot processing is especially useful when you need consistent visual evidence across many documents. For example, you can use the screenshots to support instructions, explain screen states, or verify that generated documentation reflects the intended application experience.
📷 Screenshot pending: The documentation generation screen showing the “4. Generation Running” stage and the “Cancel Generation” action.
Prerequisites
Before you begin, make sure you have the following:
- Access to an Atloria project with documentation generation available.
- A project or version selected for generation.
- Documentation content or source material ready to generate.
- Permission to view generated documents and screenshots.
- A browser session that remains open while you monitor generation, if your organization requires active monitoring.
- An understanding of which generated documents need visual screenshots.
Step-by-Step Instructions
-
Open Documents from the Atloria application navigation.
-
Select the project whose documentation you want to generate.
-
Select the relevant project version when version-specific documentation is available.
-
Click Generate Documentation →.
-
Review the generation options that are presented for the selected project.
-
Start the documentation generation process.
-
Watch for the 4. Generation Running status to confirm that generation is in progress.
-
Wait for the generation process to finish before reviewing its visual output.
-
Click Manage Screenshots → when the action becomes available.
-
Review the screenshots displayed for the generated documentation.
-
Open a generated document from Documents when you need to confirm how screenshots support its instructions.
-
Click View Source when you need to compare generated documentation with its available source material.
-
Select Source when you need to focus on the source view rather than the documentation view.
-
Return to Documents after completing your screenshot review.
📷 Screenshot pending: The generated documentation area with the “Manage Screenshots →” action available for reviewing batch-produced screenshots.
Tips and Best Practices
-
Start screenshot processing as part of a complete documentation generation, not as an isolated review activity. The screenshot output is most useful when you can compare it with the documents created in the same generation.
-
Monitor the 4. Generation Running stage before expecting screenshots to be available. If generation is still running, visual documentation assets may not yet be ready for review.
-
Use Manage Screenshots → as your primary review location. This keeps screenshot review separate from reading or editing individual documents.
-
Use View Source when a generated screenshot or document needs validation against its original material. Source review can help you determine whether an issue comes from the available source information or from the generated documentation.
-
Review screenshots in the context of the intended audience. A screenshot that is useful for an administrator-focused document may not provide enough guidance for an end-user document.
-
Keep visual documentation aligned with the generation output. If you regenerate documentation after changing the underlying project material, review the screenshots again so that your visual guidance remains consistent.
-
Avoid canceling a generation unless necessary. Selecting Cancel Generation stops the active generation workflow, which can prevent the expected documentation and screenshot output from becoming available.
📷 Screenshot pending: A document view showing the “View Source” and “Source” actions used to validate generated documentation against its source material.
Related Pages
- Generate Documentation
- Manage Screenshots
- Review Generated Documents
- View Documentation Source
- Compare Document Changes
- Export Documentation
Troubleshooting
The Manage Screenshots → action is not available
Confirm that you started a documentation generation for the selected project or version. If the generation is still in progress, wait until the 4. Generation Running stage completes before checking for screenshots.
Generation is taking longer than expected
Check whether the screen still shows 4. Generation Running. If it does, allow the process to continue. Use Cancel Generation only if you intentionally need to stop the current generation and restart it later.
A generated document does not appear to match its screenshot
Open the document and select View Source. Review the available source material to determine whether the mismatch originates in the source information or in the generated documentation. If needed, regenerate the documentation after the source material has been corrected.
Was this page helpful?