Enable AI Documentation Generation

Use AI Documentation Generation to create technical documentation for an eligible project from the project workspace. Enabling generation helps you turn project information into documentation faster and gives you a generation process you can monitor or cancel when needed.

Overview

AI Documentation Generation is available from the Projects area. You use it to select a project, start documentation generation, and then follow the generation status from the project’s documentation workspace.

This feature is useful when you need a documentation baseline for a project without writing every page manually. After generation starts, the project displays the 4. Generation Running stage. You can wait for generation to finish, or select ▣ Cancel Generation if you need to stop the process.

Generation is intended for eligible projects. If you cannot find the generation option for a project, confirm that you have opened the correct project and that it is available in your organization’s project list. You can also use project search to locate the project before starting.

📷 Screenshot pending: The Projects screen showing the Generation area and the Generate Documentation button.

Prerequisites

Before you begin, make sure that you have:

• Access to the Projects area.
• An eligible project available in the project list.
• Permission to work with the project’s documentation.
• A project you can locate using Search projects... or Search across all projects....
• A reason to generate new documentation rather than import existing material through Or import existing documentation.
• Time to monitor the initial generation, especially if you may need to select ▣ Cancel Generation.

Step-by-Step Instructions

1. Select Projects to open the project hub.

2. Enter the project name in Search projects... to narrow the project list.

3. Select the project that needs AI-generated documentation.

4. Select Generation to open the project’s generation area.

5. Review the project information to confirm that you are working in the intended project.

6. Select Generate Documentation → to begin AI documentation generation.

7. Wait for the screen to show 4. Generation Running to confirm that generation has started.

8. Select View Your Documentation → after generation is available to open the generated documentation.

9. Select Export Documentation if you need a copy of the generated documentation outside the application.

📷 Screenshot pending: A project documentation generation screen displaying the “4. Generation Running” status and the “▣ Cancel Generation” action.

Cancel a generation in progress

1. Open the project that has the 4. Generation Running status.

2. Select ▣ Cancel Generation to stop the active generation.

3. Return to the project’s documentation area when you are ready to review existing documentation or start another generation.

Enable ongoing project updates

1. Open the project’s generation or documentation controls.

2. Select 3. Schedule Enabled when scheduled generation is available for the project.

3. Select ⚡ Enable Versioning if you want to enable version tracking for the documentation.

4. Select 5. Enable Versioning to continue through the versioning stage when it is displayed in the project workflow.

Tips and Best Practices

• Use Search projects... before opening a project when your organization has many projects. This reduces the risk of generating documentation for the wrong project.

• Confirm the project before selecting Generate Documentation →. Generation is started from the project workspace, so the documentation produced is associated with the project you currently have open.

• Treat 4. Generation Running as an active processing state. Avoid assuming the documentation is ready until you can select View Your Documentation → and review the result.

• Use ▣ Cancel Generation only when you intentionally want to stop the current run. If you cancel, review the project documentation afterward to determine whether any previously available documentation remains useful.

• If your organization maintains documentation over time, enable scheduling with 3. Schedule Enabled where available. Scheduled generation can help keep documentation aligned with project changes.

• Enable versioning with ⚡ Enable Versioning when you need to preserve and compare documentation over time. This is particularly useful before major releases or significant project updates.

• If you already have approved documentation, consider Or import existing documentation instead of immediately generating new content. Imported material may be more appropriate when you need to preserve an established documentation set.

• Review generated documentation before distributing or exporting it. AI-generated content is a starting point and should be checked for accuracy, completeness, terminology, and organization-specific requirements.

Related Pages

• Manage Projects — Find, open, and organize projects from the Projects hub.
• View Generated Documentation — Open documentation using View Your Documentation →.
• Export Documentation — Download or distribute generated project documentation.
• Enable Documentation Versioning — Use ⚡ Enable Versioning to track documentation changes.
• Compare Documentation Versions — Review differences between saved documentation versions.
• Import Existing Documentation — Use Or import existing documentation when you already have source material.
• Review Project Changes — Review project changes that may affect generated documentation.

Troubleshooting

You cannot find the Generate Documentation option

1. Select Projects to return to the project hub.

2. Enter the project name in Search projects....

3. Open the correct project and select Generation.

If the option is still unavailable, the project may not be eligible for AI Documentation Generation or you may not have the required access. Contact your organization’s Atloria administrator.

Generation remains on “4. Generation Running”

1. Stay on the project’s generation screen and confirm that 4. Generation Running is still displayed.

2. Wait for the status to change before selecting View Your Documentation →.

3. Select ▣ Cancel Generation only if you need to stop the active generation.

If the status does not progress, contact your administrator and provide the project name and the status shown on screen.

You need to retain documentation history

1. Open the project’s documentation controls.

2. Select ⚡ Enable Versioning.

3. Continue through 5. Enable Versioning if it appears as the next workflow stage.

After versioning is enabled, use the project’s version history and comparison tools to review documentation changes over time.