You can export documentation results into shareable files for stakeholders, audits, and operational reporting. This page explains how to create a CSV or JSON export from your documentation results.
Overview
Documentation reporting exports let you take the results shown in Atloria and use them outside the application. Use an export when stakeholders need a spreadsheet-friendly summary, when an operations team needs to combine documentation data with another reporting source, or when you need to retain a point-in-time record.
Atloria provides export actions for both CSV and JSON formats. Choose Export CSV when recipients will review the data in spreadsheet software. Choose Export JSON when the export will be consumed by another reporting, analysis, or data-processing tool.
Exporting does not change the documentation results displayed in Atloria. It creates a file based on the results available when you start the export. If your documentation has changed since a prior export, create a new export so your reporting file reflects the current results.
📷 Screenshot pending: Documentation results area showing the Export Documentation action and available export formats.
Prerequisites
Before you start, make sure you have the following:
- Access to the project’s Analytics area.
- Documentation results available to review.
- Permission to view the documentation results you want to report on.
- A clear reporting purpose, such as stakeholder review, operational analysis, or archival.
- Spreadsheet software for CSV files, if you plan to open the export in a spreadsheet.
- A compatible reporting or data-analysis tool for JSON files, if you plan to process structured data.
Step-by-Step Instructions
-
Open the project where you want to report on documentation results.
-
Open the project’s Analytics area.
-
Select View Results to display the available documentation results.
-
Review the displayed results before exporting them.
-
Select Export Documentation.
📷 Screenshot pending: Export Documentation options showing Export CSV and Export JSON actions.
-
Select 📄 Export CSV to download the results in CSV format.
-
Open the downloaded CSV file in your preferred spreadsheet application.
-
Select 📄 Export JSON instead when you need a structured JSON file for a reporting system or data workflow.
-
Save the downloaded export using a filename that identifies the project and reporting date.
-
Share the exported file with the intended stakeholders through your organization’s approved sharing process.
Tips and Best Practices
-
Use 📄 Export CSV for stakeholder-ready reporting. CSV files are typically the easiest format to review, filter, sort, and incorporate into spreadsheet-based status reports.
-
Use 📄 Export JSON when the recipient needs structured data rather than a spreadsheet. JSON is a better choice for operational workflows that import, transform, or analyze documentation results in another system.
-
Review results through View Results before you export. This helps you confirm that the output represents the documentation results you intend to report, rather than exporting without checking the current information.
-
Create a fresh export whenever documentation results are regenerated or updated. An existing downloaded file does not update automatically after changes are made in Atloria.
-
Use a consistent naming convention for exported files. For example, include the project name, report purpose, and export date so stakeholders can distinguish current reporting from older snapshots.
-
Keep the exported format aligned with the audience. A project sponsor may prefer CSV for quick review, while an operations or analytics team may request JSON for downstream processing.
-
If you are exporting results to support documentation review, distinguish the report’s purpose clearly. Atloria can be used for different documentation needs, including User Guides and User Manuals, so label the exported file according to the audience and document type it supports.
Related Pages
- View Documentation Results — Review the available documentation output before creating an export.
- Generate Documentation — Create or refresh documentation before reporting on it.
- User Guides — Learn how to work with documentation intended for end users.
- User Manuals — Learn how to access and manage manual-oriented documentation.
- Analytics Overview — Understand the reporting information available in the project Analytics area.
Troubleshooting
The export actions are not available
Confirm that you opened View Results and that documentation results are available. If you cannot see Export Documentation, verify that you have access to the project and its Analytics area.
I exported the wrong format
Create a new export using the appropriate option. Select 📄 Export CSV for spreadsheet review, or select 📄 Export JSON for structured reporting and data-processing workflows.
The exported file does not include recent documentation changes
Return to View Results and verify that the current results are displayed. If documentation was recently generated or updated, create a new export using Export Documentation so the downloaded file reflects the latest available results.
Was this page helpful?