Create an application user guide

When you build an application with Aha! Builder, users need clear guidance so they can get value from it right away. A dedicated user guide gives them step-by-step instructions that match your application's structure — so people always know what to do next. Because the same AI that built your application also writes the user guide, you get accurate, tailored content in minutes instead of spending hours drafting it yourself.

Click any of the following links to skip ahead:

• Overview

• Create a user guide

• Edit a page in your user guide

• Add a page to your user guide

Overview

Elle, the AI assistant, analyzes each section of your application and creates a structured user guide. Each article includes step-by-step instructions and screenshots. You can add, reorder, or remove articles so the guide reflects the tasks your users need to accomplish.

Top

Create a user guide

You can create the first draft of your user guide with the click of a button:

1. Open your application in Aha! Builder.

2. Navigate to Documents -> User guide.

3. Select Create user guide.

4. Enter the details about the type of user guide you want to create:

   • Audience: Specify who the user guide is for.

   • Sections: Explain how you want the guide to be organized.

   • Tone: Define the writing style.

   • Placements: Describe where the user guide should appear in the application.

5. Click Create, which prompts Elle to generate the user guide.

The user guide for your application opens, with each article listed on the left. From here, you can drag and drop the articles into your preferred order and edit the articles directly. Right-click a document to reveal options to duplicate it or delete it.

Top

Edit a page in your user guide

You can edit your user guide to provide extra context for your application's users. This is a great way to add best practices for using your application to perform specific organizational functions.

1. Open your application in Aha! Builder.

2. Navigate to Documents -> User guide.

3. Open the page you want to open by clicking its title on the left.

4. Use the text editor to edit the page.

Edits to your user guide save automatically.

Top

Add a page to your user guide

1. Open your application in Aha! Builder.

2. Navigate to Documents -> User guide.

3. Click Add article at the top of your screen.

4. Add a title. Then, use the text editor to draft your article. Select the Elle icon from the text editor toolbar to ask Elle for help.

Top