Documentation tests help you verify that generated and maintained documentation remains complete, consistent, and ready to publish. This page explains how to prepare a documentation test run, review the results, and understand how the __tests__ areas are organized in your development workspace.
Overview
Documentation testing is used when you need to confirm that documentation-related changes still produce the expected output. Run these checks before sharing updated manuals, exporting documentation, or treating generated content as ready for reviewers.
In Atloria, documentation work commonly moves from generation to review and publication. You can begin the documentation workflow with Generate Documentation →, review the resulting material, and use Export Documentation when the content is ready for use outside Atloria. Tests provide an additional quality check during this process by identifying issues before documentation is considered complete.
The __tests__ areas are organized alongside the parts of the project they validate. This keeps each set of documentation tests close to the feature, screen, or workflow it covers. When you review a failed result, use the test name and its related documentation area to identify what needs attention rather than treating all test results as one undifferentiated list.
📷 Screenshot pending: The documentation testing workspace showing available test groups, run controls, and result status.
Prerequisites
Before you start, make sure you have the following:
- Access to the Atloria development-testing environment for your organization.
- Permission to view and run documentation test results.
- A documentation update, generated draft, or testable project version to validate.
- Any required project dependencies or test environment setup completed by your development team.
- A clear understanding of whether you are testing generated documentation, imported documentation, or documentation templates.
- A browser session signed in to the appropriate Atloria workspace.
Step-by-Step Instructions
-
Open your Atloria development-testing workspace.
-
Select the documentation test area for the project or documentation update you want to validate.
-
Review the available
__tests__groups to identify the tests associated with the documentation area you changed. -
Select the test group that matches the feature, documentation template, or generated document you need to check.
-
Confirm that the selected test group is associated with the correct project version or documentation draft.
-
Start the documentation test run using the available run control in your testing workspace.
-
Wait for the test run to finish before reviewing individual results.
-
Review the overall result status to determine whether the documentation test run passed or reported failures.
-
Select a failed result to view the test name and the documentation behavior that did not meet expectations.
-
Compare the failed result with the corresponding documentation content, template, or generation settings.
-
Correct the identified documentation issue in the appropriate authoring or generation workflow.
-
Run the affected documentation test group again after making the correction.
-
Repeat the review and correction process until the applicable tests pass.
-
Select Generate Documentation → if you need to regenerate documentation after correcting an issue.
-
Review the generated output before treating it as ready for publication.
-
Select Export Documentation only after the relevant documentation tests have passed and the output has been reviewed.
📷 Screenshot pending: A completed documentation test run with passed and failed result indicators and an expanded failure detail.
Tips and Best Practices
-
Run the smallest relevant
__tests__group first. This helps you isolate a documentation issue quickly and avoids reviewing unrelated results. -
Use test names as your first clue when troubleshooting. Because tests are organized near the documentation area they validate, the result name should help you identify whether the issue concerns a template, generated content, navigation, or expected text.
-
Test after meaningful documentation changes. Run tests after updating documentation templates, changing generated content, importing existing documentation, or revising user-facing labels.
-
Generate documentation before final review when your change affects generated output. Select Generate Documentation → and then validate the resulting material with the appropriate tests.
-
Do not export unverified output. Use Export Documentation only after reviewing successful results and confirming the documentation is appropriate for its intended audience.
-
Keep documentation tests focused. A test group should verify one clear documentation behavior or outcome. Focused test groups are easier to understand, rerun, and maintain.
-
Use Documentation Templates when a repeated structure or standard format is involved. Consistent templates make test results easier to interpret across multiple documents.
Related Pages
- Documentation Templates — Learn how to use consistent document structures before testing output.
- Generating Documentation — Learn how to create or regenerate documentation with Generate Documentation →.
- Export Documentation — Learn when and how to use Export Documentation after review.
- Documentation Ready! — Learn the final readiness checks for documentation that is prepared for publishing or sharing.
Troubleshooting
The documentation test run cannot be started
Verify that you are in the correct Atloria development-testing workspace and that you have permission to run tests. If the run control is unavailable, ask an administrator to confirm your access and the availability of the selected project version.
A test fails after documentation was generated
Open the failed result and review the documentation behavior identified by the test. Correct the relevant content, template, or generation setting, then run the affected test group again. Do not rely on a previous successful run after changing documentation output.
Tests pass, but the documentation still needs changes
A passing test confirms the behavior covered by that test; it does not replace editorial review. Review the generated documentation for clarity, audience suitability, and completeness before selecting Export Documentation.
Was this page helpful?