# Generate Documentation with AI

You can generate a documentation draft using your project context and the scope you choose. This helps you create a focused starting point that you can review, save, and refine before publishing.

## Overview

AI-generated documentation uses the information available for your selected project to prepare a draft. Use it when you need a first version of user-facing documentation without starting from a blank page.

Start from the **Projects** area, open the project you want to document, and use the documentation generation action available for that project. The generation process creates a draft rather than immediately replacing your existing documentation, so you can review the result before deciding what to keep.

Your draft moves through a simple lifecycle:

- **Draft:** The generated content is available for review and editing.
- **Saved as Draft:** You have stored the draft for later work.
- **Regenerated:** A new AI-generated version is created from the current project context and selected scope. Review the new version before using it in place of an earlier draft.

> 📷 _Screenshot pending: The Projects hub showing available projects and the project selection area._

## Prerequisites

Before you begin, make sure you have:

- Access to the **Projects** area.
- A project selected that contains the context you want the AI to use.
- A clear documentation topic or scope in mind.
- Permission to view and update documentation for the project.
- Time to review the generated **Draft** before sharing or publishing it.

## Step-by-Step Instructions

1. Click **Projects** to open the list of available projects.

2. Select the project whose context you want to use for the documentation draft.

3. Open the project’s documentation area and locate **User Docs**.

4. Choose the documentation scope you want the AI to cover using the available scope selection controls.

5. Click **✦ Regenerate AI docs** to generate a new AI documentation draft.

6. Wait for the generation process to finish until the **3. Draft Ready** state is displayed.

7. Click **View Draft** to open the generated documentation.

> 📷 _Screenshot pending: The documentation generation screen showing the “3. Draft Ready” state and the “View Draft” action._

8. Review the draft to confirm that it covers the selected scope and uses the correct project terminology.

9. Click **Save as Draft** to retain the reviewed version for later editing.

10. Click **Generate More** if you need to create documentation for another topic or scope.

11. Click **↻ Re-generate** if you need a fresh draft for the same documentation area.

12. Click **Regenerate** when you want to replace the current generated result with a newly generated version.

13. Click **View Your Documentation →** when you are ready to open the documentation that has been created for the project.

> 📷 _Screenshot pending: A generated User Docs draft open for review, with Save as Draft and regeneration actions available._

## Tips and Best Practices

- Select a focused scope before generating. A narrowly defined topic generally produces a more useful draft than a broad request covering many unrelated areas.

- Review every generated draft before saving it. AI generation creates a starting point, so you should verify instructions, terminology, and any project-specific behavior.

- Use **Save as Draft** after reviewing a version you may want to return to. This lets you preserve the draft while you continue planning or validating the content.

- Use **↻ Re-generate** or **Regenerate** when the output does not match your intended topic. Regeneration is useful after you change the selected scope or when the project context has changed.

- Generate one focused document at a time. For example, create a separate draft for a task such as “How to create a maintenance request” rather than combining unrelated procedures in one page.

- Use **Generate More** after completing the current draft to create additional documentation topics from the same project.

- If you are unsure whether you are working in the correct project, use **← Back to Projects** and select the appropriate project before generating again.

## Related Pages

- [Manage Projects](#)
- [View User Docs](#)
- [Review and Save Documentation Drafts](#)
- [Regenerate AI Documentation](#)
- [Project Changes](#)
- [Technical Documentation](#)

## Troubleshooting

### The generated draft does not cover the topic you expected

Return to the documentation generation area and adjust the scope selection. Then click **✦ Regenerate AI docs** or **↻ Re-generate** to create a new draft. Review the new **Draft** before saving it.

### You cannot find the project you want to document

Click **← Back to Projects** to return to the project list. Select the correct project, then reopen **User Docs** and start the generation process again.

### You generated a draft but cannot see the content

Confirm that the screen shows **3. Draft Ready**. Then click **View Draft**. If the draft still does not meet your needs, use **Regenerate** to create another version and review it before selecting **Save as Draft**.