Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions content/en/docs/developerportal/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,6 @@ The following sections describe the process for each option.

### Creating an App with Maia

{{% alert color="warning" %}}
This feature is in Public Beta. For more information, refer to [Release Status](/releasenotes/release-status/).
{{% /alert %}}

Follow the steps in [Maia Plan](/developerportal/maia-plan/) to enlist Maia's help in planning and creating an app.

### Creating an App from a Starter App Template
Expand Down
60 changes: 37 additions & 23 deletions content/en/docs/developerportal/maia-plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,36 +3,35 @@ title: "Maia Plan"
url: /developerportal/maia-plan/
description: "Describes the process of planning and building an app using Maia."
weight: 3
beta: true
---

{{% alert color="warning" %}}
This feature is in Public Beta. For more information, refer to [Release Status](/releasenotes/release-status/).
{{% /alert %}}

## Introduction

You can use Maia Plan to plan and generate an app. This page details the steps involved in providing project context, reviewing and refining the generated project scope, and approving the solution proposal to initiate app development.
You can use Maia Plan to plan and generate an app. This page describes how to provide project context, review and refine the generated project scope, and approve the solution proposal to initiate app development.

{{< figure src="/attachments/developerportal/maia/maia-create-app-beta.png" alt="Plan and build with Maia" >}}
{{< figure src="/attachments/developerportal/maia/maia-create-app.png" alt="Plan and build with Maia" >}}

## Creating an App with Maia Plan

Follow these steps to have Maia Plan create an app for you:
Go through the steps in the following sections to have Maia Plan create an app for you.

### Adding Project Details

1. In **Apps**, click **Create App** in the upper right corner.

2. Select **Plan & Build with Maia**.

3. In the **Project Context** text box, enter as much detail as possible about your future app. These are some details that you could add to help Maia generate an app for you:
3. In the **Project Context** text box, enter as much detail as possible about your future app. Include the following information to help Maia generate an accurate app plan:

* Describe your goals.
* Describe your targeted users.
* List out success criteria.
* Add requirements.
* Attach documents, sketches, images.

4. Click **Generate Plan**. The **Project Scope** window is displayed, and Maia starts populating it with the proposed project scope.
### Generating the Project Scope

1. Once you have added all the preliminary details, click **Generate Plan**. The **Project Scope** window is displayed, and Maia starts populating it with the proposed project scope.
The app plan becomes available on the **Apps** page as soon as you click **Generate Plan** at the beginning of the workflow. As such, you can go back to the plan at any time after you leave it, and you can already add team members to the app.

Once the **Project Scope** window is populated, you can see the following information generated by Maia:
Expand Down Expand Up @@ -61,22 +60,37 @@ Follow these steps to have Maia Plan create an app for you:

You can use the pane on the right to chat with Maia about your requirements for the new app.

5. Once you review the project scope and make any changes you deem necessary, click **Approve Project Scope** in the top right of the page. The status of the project scope changes from **Draft** to **Approved**.
2. Once you review the project scope and make any changes you deem necessary, click **Approve Project Scope** in the top right of the page. The status of the project scope changes from **Draft** to **Approved**.

6. Click **Generate Solution** in the top right of the page. The **Solution Proposal** window is displayed, and Maia starts populating it with the proposed project scope.
While the solution proposal is being generated, as well as after it's displayed, the **Project Scope** is locked. If you want to make changes to it, you can click the lock icon to unlock it.
Once the **Solution Proposal** window is populated, you can see the following information generated by Maia:
### Generating the Solution Proposal

* Cards corresponding to each epic which contributes to building the app.
You can remove epics by hovering over them, then clicking the trash can icon.
Click the card itself to:
If you agree with the project scope, click **Generate Solution** in the top right of the page. The **Solution Proposal** window is displayed, and Maia starts populating it with the proposed project scope.
While the solution proposal is being generated, as well as after it's displayed, the **Project Scope** is locked. If you want to make changes to it, you can click the lock icon to unlock it.
Once the **Solution Proposal** window is populated, you can see the following information generated by Maia:

* See the entire list of stories for an epic in the right side panel.
* Edit the description or details of the epic.
* Cards corresponding to each epic which contributes to building the app.
You can remove epics by hovering over them, then clicking the trash can icon.
Click the card itself to:

* See the entire list of stories for an epic in the right side panel.
* Edit the description or details of the epic.

You can perform the following actions on each story:
You can perform the following actions on each story:

* To see the full details of a story or to edit it, click the three-dot menu, then select **Edit**.
* To remove a story, click the three-dot menu, then select **Delete**.

* To see the full details of a story or to edit it, click the three-dot menu, then select **Edit**.
* To remove a story, click the three-dot menu, then select **Delete**.
#### Recommended Marketplace Components

If Mendix identifies Marketplace components that can be used to implement a specific story, they are displayed as follows:

* At the epic level, as a number. Example: *1 Resource*.
* At the user story level, in the side panel. From here, you can perform the following actions:

* If you want more details about the component, click it to access its page in the Marketplace.
* If you do not want a component to be used, delete it by clicking the trash can icon.

### Opening the App in Studio Pro

7. Once you are happy with Maia's suggested project plan, click **Open in Studio Pro** in the top right of the page. This opens Studio Pro, where you can continue working on the new app. For details, refer to [Maia Make](/refguide/maia-make/) in the Studio Pro documentation.
Once you are happy with Maia's suggested project plan, click **Open in Studio Pro** in the top right of the page. This opens Studio Pro, where you can continue working on the new app. For details, refer to [Maia Make](/refguide/maia-make/) in the Studio Pro documentation.
You can also click **Open in Planning** to open the **Planning** window of the new app, which includes all the project's stories.