# Understand the Atloria Platform Atloria helps you generate, review, publish, and support technical documentation for your software. This page explains the main platform areas so you can understand how documentation moves from analysis to a published experience. ## Overview Atloria brings together documentation generation, publishing, support, and administration in one platform. You use it when you need to turn information about an application into organized technical documentation, make that documentation available to the right audience, and maintain it as your product changes. The platform is organized around several visible areas. **Technical Docs** is where documentation work is centered. From there, you can begin generation, review available documentation, export documentation, or import existing material. The **Atloria Stack** and **Components** areas help you understand the parts of the software that contribute to the documentation set, such as user-facing application elements, supporting services, data-related areas, configuration, and infrastructure. Documentation generation is a staged process. Atloria can identify information across categories such as **FRONTEND**, **BACKEND**, **DATABASE**, **API SCHEMA**, **CONFIG**, **DOCUMENTATION**, and **INFRASTRUCTURE**. As generation progresses, you may see **4. Generation Running**. When the process finishes, the result may indicate that the parse completed successfully or completed with warnings. Warnings do not necessarily prevent documentation from being created, but they indicate that you should review the output carefully. After generation, you can use publishing features to make documentation available through a shareable documentation site. Atloria also includes support-oriented tools, including **🤖 AI Support**, **Support Agent**, and **6. Support Chat**, so users can find answers while viewing published documentation. > 📷 _Screenshot pending: The Atloria workspace showing Technical Docs, Atloria Stack, Components, Generation, Publishing, and Support Agent areas._ ## Prerequisites Before you begin working with Atloria, make sure you have the following: - Access to your organization’s Atloria workspace. - Permission to connect or authorize the software source that Atloria will analyze. - A clear understanding of the documentation audience you want to serve, such as internal technical teams or external users. - Existing documentation files if you plan to use **Or import existing documentation** instead of generating new content. - Time for the generation process to complete, especially for a large or complex application. - A plan for reviewing warnings and validating generated documentation before publishing it. ## Step-by-Step Instructions 1. **Open the documentation area.** In your Atloria workspace, select **Technical Docs**. This is the starting point for creating or managing technical documentation. Use this area when you want to generate documentation from your application or work with documentation that already exists. 2. **Choose how you want to create documentation.** If you want Atloria to create documentation based on your connected application, select **Generate Documentation →**. If you already have documentation that you want to bring into Atloria, select **Or import existing documentation**. Generating documentation is useful when you need Atloria to organize information from across your software. Importing is useful when you have established content that should be retained, improved, or published through Atloria. 3. **Authorize Atloria when prompted.** Select **Authorize Atloria** to allow the platform to access the connected source needed for documentation generation. Complete the authorization steps shown on screen before continuing. Authorization is important because Atloria needs access to the relevant application information before it can analyze the software and prepare documentation. 4. **Start documentation generation.** Select **Generate Documentation →** and confirm the settings presented to you. Atloria begins examining relevant areas of the application, including frontend, backend, database, API schema, configuration, documentation, and infrastructure information. During this work, the platform may display **4. Generation Running**. Keep the workspace open or return later to check progress. If you need to stop the process, select **◼ Cancel Generation**. 5. **Review the generation outcome.** When generation is complete, review the status shown in Atloria. A successful result means the analysis completed without errors. A result with warnings means Atloria completed the process but found items that may need your attention. Review the generated documentation for completeness, especially where your application has complex relationships between components. For example, a component may render another component or use a hook; these relationships can help explain how the application works, but they should be checked for accuracy and usefulness to your intended readers. 6. **Open and review your documentation.** Select **View Your Documentation →** to open the generated documentation experience. Review page titles, structure, terminology, and audience suitability before sharing it more broadly. Confirm that the content explains the user-visible behavior of your application and that sensitive internal details are not exposed to the wrong audience. 7. **Publish or export the approved content.** Use the **Publishing** area when the documentation is ready to share. If you need a portable copy for another process, select **Export Documentation**. Publishing lets readers access the documentation through a public or audience-specific documentation experience. Exporting is useful for archiving, review workflows, or delivery outside the platform. 8. **Enable support experiences as needed.** Use **🤖 AI Support**, **Support Agent**, or **6. Support Chat** when you want readers to receive help while using the documentation. These options are particularly useful after publishing, when readers may need clarification without contacting your team directly. > 📷 _Screenshot pending: The Technical Docs area showing Generate Documentation, Generation Running status, Cancel Generation, and View Your Documentation actions._ ## Tips and Best Practices - **Start with the intended audience.** Documentation for technical teams may need more implementation context, while customer-facing documentation should focus on tasks and outcomes. Review generated material with the reader’s needs in mind. - **Treat warnings as review items.** A completed generation with warnings can still provide useful output. However, you should inspect the affected areas before publishing and fill in missing explanations where necessary. - **Use imports to preserve established content.** Select **Or import existing documentation** when you already have approved manuals, policies, or technical references that should remain part of your documentation library. - **Review before publishing.** Generation helps organize information, but you remain responsible for accuracy, clarity, and appropriate access. Use **View Your Documentation →** to validate the published reading experience. - **Use support tools after publication.** **🤖 AI Support** and **6. Support Chat** can help readers find answers quickly, reducing repetitive questions sent to your documentation team. - **Cancel only when necessary.** Select **◼ Cancel Generation** only when you need to stop the current run. If generation is progressing normally, allow it to complete so you can review the results and any warnings. ## Related Pages - [Generate Documentation](#) - [Import Existing Documentation](#) - [Review Generated Documentation](#) - [Publish Documentation](#) - [Export Documentation](#) - [Configure AI Support](#) - [Use the Atloria Recorder](#) ## Troubleshooting ### Generation is still showing “4. Generation Running” Wait for the process to complete and refresh the workspace if needed. Large applications or applications with multiple areas can take longer to analyze. Avoid starting a second generation unless you intentionally need a new run. ### Generation completed with warnings Open the generated documentation using **View Your Documentation →** and review the affected content. Warnings indicate that Atloria completed the process but may not have captured every detail cleanly. Add or revise documentation before publishing if important information is incomplete. ### You cannot start generation or access connected application information Confirm that you completed **Authorize Atloria** and that you are using an Atloria workspace where you have the required access. If authorization is no longer valid, repeat the authorization process before selecting **Generate Documentation →**.