Configure Generation Scope

page

4 min readUpdated 2026-07-20

Configure the generation scope to define which project information and documentation areas Atloria uses when preparing documentation. A clear scope helps you generate documentation that is relevant to the selected project and avoids unnecessary output.

Overview

Generation scope determines the project context used for documentation generation. You begin from the project you want to document, then use the project’s Generation area to review the available information and documentation coverage before starting generation.

Atloria organizes project analysis into documentation areas such as FRONTEND, BACKEND, DATABASE, API SCHEMA, CONFIG, DOCUMENTATION, and INFRASTRUCTURE. The areas available for a project depend on the information Atloria has identified or configured for that project.

Use generation scope when you are preparing documentation for a new project, when a project’s implementation changes, or when you want to focus documentation work on specific parts of the project rather than treating all projects as one workspace.

📷 Screenshot pending: The Generation area for a focused project, showing the project context and available documentation areas.

Prerequisites

Before you configure generation scope, make sure that:

You can access the Projects hub.
The project you want to document has already been created.
You have selected the correct project from the project list.
The project has been configured or analyzed sufficiently for Atloria to identify documentation areas.
You know whether you need documentation for frontend, backend, database, API schema, configuration, documentation, or infrastructure information.

Step-by-Step Instructions

Open Projects from the main application navigation.
Use Search projects... if you need to locate a project by name.
Select the project you want to configure.
Confirm that you are working in the correct focused project by reviewing the project context in the project sidebar.
Select Generation from the project navigation.
Review the project information shown in the Generation area.
Review the documentation areas available for the project.
Include the FRONTEND area when you need documentation about user-facing application components and behavior.
Include the BACKEND area when you need documentation about server-side services and application processing.
Include the DATABASE area when you need documentation about stored data and database-related entities.
Include the API SCHEMA area when you need documentation about application interfaces and API definitions.
Include the CONFIG area when you need documentation about project configuration.
Include the DOCUMENTATION area when you need Atloria to consider existing documentation-related project content.
Include the INFRASTRUCTURE area when you need documentation about deployment, environment, or infrastructure-related project information.
Review the selected project and documentation areas before continuing.
Start generation using the available generation action in the Generation area.
Wait for the generation status to show that processing is running.
Select Cancel Generation only if you need to stop the current generation run.
Open the generated project documentation when it becomes available.
Select Export Documentation if you need a copy of the completed documentation outside Atloria.

📷 Screenshot pending: The Generation screen with project information, documentation areas, and the action used to begin generation.

Tips and Best Practices

Configure scope from the focused project, not from the Projects hub. This helps ensure the generated documentation is tied to the intended project.
Use Search projects... before opening a project when your organization manages many projects. Selecting the wrong project can produce documentation for the wrong codebase or product area.
Include only the documentation areas that support your immediate documentation goal. For example, a user-interface guide may primarily need FRONTEND coverage, while an integration guide may need BACKEND and API SCHEMA coverage.
Include DATABASE when the documentation must explain data entities or data relationships. Leave it out when the intended audience does not need data-model information.
Include CONFIG and INFRASTRUCTURE when operational teams need the resulting documentation. These areas are especially useful for deployment, environment, and maintenance-oriented documentation.
Review scope before you begin generation. If you change your mind after generation has started, use Cancel Generation and update the scope before starting another run.
Wait for the current generation run to finish before relying on the documentation or using Export Documentation. Exporting is most useful after the generated content is complete.

📷 Screenshot pending: A generation run in progress, including the Cancel Generation action and completion status area.

Troubleshooting

The project does not appear in the project list

Open Projects.
Enter the project name in Search projects....
Select New Project if the project has not yet been created.
Complete project creation before returning to configure generation scope.

The documentation area you need is not available

Confirm that you opened the correct project.
Review the project’s configured information and analysis status.
Make sure the project contains the relevant type of information, such as frontend, backend, database, API schema, configuration, documentation, or infrastructure content.
Run generation again after the project information has been updated or configured.

Generation is taking longer than expected

Open Generation for the selected project.
Check whether generation is still running.
Wait for the current generation to complete.
Select Cancel Generation only when you intend to stop the run and revise the scope before generating again.

Was this page helpful?

Download as PDF

ADocs generated by Atloria — from the code, always in sync →