Introduction
After you generate a new documentation version in Atloria, the next job is deciding whether that output is ready to move forward. This is where version comparison becomes useful. Instead of relying on memory or scanning pages one by one, you use the version workspace to look at what changed, what still needs attention, and whether the generated content is in a good enough state for review.
In Atloria, version work happens inside your project area. From there, you can move between project pages, version lists, analytics views, and related project tools. When you open a version comparison view, the goal is practical: identify meaningful differences, confirm that expected updates appeared, and spot anything that looks incomplete before you send the version into the next stage.
This guide focuses on the user-facing workflow for comparing generated output and judging release readiness. It does not repeat how to create a version in the first place. If you need that part, go back to Generating New Documentation Versions.
As you work through comparison, pay attention to visible changes in document content, structure, and project-level signals that help you decide whether the version should stay in progress or move toward review. [SCREENSHOT: version list in a project workspace with a selected generated version ready for comparison]
Overview
In Atloria, comparing version output usually starts from the project workspace where your documentation versions are listed. From that list, you open the version you want to inspect and compare it against an earlier version or the current working baseline. The comparison view helps you answer three questions:
- What changed?
- Are the changes complete and expected?
- Is this version ready for formal review?
Atloria also includes related project areas that support this decision. For example, project analytics pages are available from project navigation, and the Admin workspace includes Analytics & Insights and Security & Audit areas. In the current interface, both of those admin pages show a “coming soon” style notice rather than detailed comparison tools, so your release-readiness decision should stay centered on the version workspace and the visible documentation output.
If your team uses screenshots, public documentation previews, or audience-specific content, those checks may also be part of readiness. The comparison step is not only about finding differences between two versions. It is also about confirming that the generated version still matches the structure, wording, and intended scope of your project documentation.
A good comparison session usually includes opening the version, reviewing changed pages, checking whether important sections are present, and deciding whether the version is ready to send into the review flow. If you want a broader understanding of statuses and release stages, see Understanding Version Lifecycle and Release Readiness. If you want more detail on comparison screens specifically, see Working with Version Comparison Views.
Steps
Use this workflow when you want to compare a newly generated version and decide whether it is ready for review.
- Open your project in Atloria and go to the version list for that project.
- Select the newly generated version you want to inspect.
- Open the comparison view and choose the version you want to compare against, such as the previous version or current baseline.
- Review visible differences in page content, structure, and any changed sections.
- Open important pages directly to confirm the generated output reads correctly in context.
- Check related items that affect release readiness, such as screenshots, audience-specific pages, or public-facing content if your team uses them.
- Decide whether the version should remain in progress for more work or move into the review stage.
While doing this, focus on the changes that matter most to readers. A version can show many small edits, but the real question is whether the documentation is accurate, complete, and ready for other people to review. If you need help managing statuses after the comparison, Atloria’s version workflow documents cover that next step in more detail.
Summary
Comparing version output in Atloria is the checkpoint between generation and review. You use the project’s version workspace to open a generated version, compare it with an earlier version, and inspect the visible differences that matter for release decisions. The most useful comparisons are not just about counting edits. They help you verify whether the generated output is complete, readable, and aligned with what your team expected to change.
Keep your decision grounded in what you can see on the screen: changed pages, updated sections, document structure, and any related content that affects the reader experience. If a version still has missing sections, unclear wording, or changes that do not match the release scope, keep it in progress and continue refining it. If the output looks complete and the changes are understandable, you can move it into the next review step with more confidence.
Atloria also includes admin areas such as Analytics & Insights and Security & Audit, but those pages are currently presented as future-ready spaces rather than active comparison tools. For release-readiness decisions, stay focused on the project version workspace and the documentation output itself.
The next document in this workflow is Managing Version Generation Jobs and Results, which explains how to track generation activity and work with the results list after comparison.
Prerequisites
Before you compare version output in Atloria, make sure you already have the basics in place:
- You can sign in to Atloria with your Email and Password on the login screen.
- You have access to the project where the version was generated.
- At least one generated documentation version exists in that project.
- You have an earlier version, baseline, or current project content available to compare against.
- You understand the generation workflow from Generating New Documentation Versions.
If you are new to Atloria access, you may first need the sign-in and account guides:
You may also find it helpful to be familiar with these project areas before starting:
- The project dashboard or project home
- The version list for the project
- Any page where your team reviews generated documentation
- Related project tabs such as analytics or webhooks, if your team uses them for project tracking
If you are an administrator, the Admin area includes cards such as Users & Permissions, Organizations, Documents, Projects, and Analytics. Those sections help with broader workspace management, but they are not required to compare a version for release readiness.
The key requirement is simple: you need a generated version and a place in the project where you can view and compare it. Without both, you cannot make a reliable readiness decision.
Step-by-Step Instructions
-
Sign in to Atloria using your Email and Password on the login page. If your details are incorrect, Atloria shows the message Invalid email or password. If something unexpected happens during sign-in, you may see An error occurred. Please try again.
-
After signing in, open the main workspace and go to the project that contains the generated documentation version. If you just created the version, continue from the project workflow you used in Generating New Documentation Versions.
-
In the project, open the version list or version workspace and select the newly generated version. Look for the version you want to evaluate before review or publishing.
-
Start a comparison against the most relevant earlier version. In most cases, this will be the previous release version or the current working version your team has been using. [SCREENSHOT: selecting a generated version and choosing a comparison target]
-
Review the changed output carefully. Focus on page titles, section order, visible content changes, and whether important documentation areas appear complete. Open changed pages directly when a summary view is not enough.
-
Check whether the generated output matches the release scope. If your team expected updates in certain documents, confirm those updates are present. If unexpected pages changed, inspect them before moving on.
-
If your project includes screenshots, public documentation, or audience-specific content, open those related areas and confirm the version still looks ready for readers.
-
Decide what to do next:
- Keep the version in progress if the output still needs edits or clarification.
- Move it forward for review if the visible content looks complete and accurate.
For a deeper comparison workflow after this first pass, continue with Comparing Documentation Versions for Release Decisions.
Key Features
Atloria gives you several visible workspace elements that support version comparison and release-readiness decisions.
| Feature or screen | What you use it for | What to look for |
|---|---|---|
| Project version list | Open generated versions and choose which one to inspect | Recent versions, naming, and which version should be compared |
| Version comparison view | Review differences between two versions | Changed pages, updated sections, and unexpected edits |
| Project workspace navigation | Move between documentation, project tools, and related tabs | Quick access to supporting checks during review |
| Admin dashboard cards | Open broader management areas such as Analytics or Projects | Useful for workspace context, but not the main place for version comparison |
| Analytics & Insights page | View analytics area from the admin workspace | Currently presented as a placeholder rather than a detailed reporting screen |
| Security & Audit page | View audit-related area from the admin workspace | Currently presented as a placeholder rather than a full audit review screen |
The most important feature for this task is the version comparison view inside the project. That is where you judge whether the generated output is usable. The surrounding navigation matters because release readiness often depends on more than one screen. You may need to move from the version list into individual documents, then back to the project workspace, and sometimes into related project pages.
If your team works with approvals, audience settings, or publishing controls, those features come after comparison. At this stage, Atloria helps you inspect the output and make a clear decision about whether the version is ready to proceed.
Tips & Best Practices
- Compare against the most meaningful earlier version. If you choose the wrong baseline, the change list can be harder to interpret.
- Start with high-impact pages first. Open the documents your readers depend on most before spending time on small wording changes.
- Do not rely only on a change summary. If a page looks important, open it and read the content in full context.
- Watch for missing sections as well as changed sections. A version can look clean in comparison but still be incomplete when you open the page itself.
- If the generated output includes unexpected changes, pause before sending it into review. It is easier to correct issues before reviewers begin commenting.
- Use project-level context when deciding readiness. If your team also maintains screenshots, audience-specific content, or public documentation views, check those areas before marking the version ready.
- Keep comparison and approval as separate decisions. A version may show the right changes but still need wording cleanup before formal review.
- If you need help with statuses, review decisions, or approval handoff, use the related guides:
When you finish comparing the output and have a sense of whether it is ready, the next useful step is tracking the generation activity itself in Managing Version Generation Jobs and Results.
Was this page helpful?