Skip to content

Commit 5f6a13a

Browse files
committed
Document Maia Plan
1 parent 3a9b1d9 commit 5f6a13a

1 file changed

Lines changed: 64 additions & 6 deletions

File tree

content/en/docs/developerportal/_index.md

Lines changed: 64 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,69 @@ cascade:
2020

2121
## Creating an App {#create-app}
2222

23-
Follow these steps to create a new app and start collaborating:
23+
There are two ways to create apps:
2424

25-
1. In **Apps**, click **Create App** in the upper-right corner. A screen opens to guide you through the process.
25+
* Using Maia to plan and build your app.
26+
* Using a starter app template.
2627

27-
2. Enter the following information for your app:
28+
The following sections describe the process for each option.
29+
30+
### Creating an App with Maia
31+
32+
{{% alert color="warning" %}}
33+
This feature is in Public Beta. For more information, refer to [Release Status](/releasenotes/release-status/).
34+
{{% /alert %}}
35+
36+
Follow these steps to have Maia plan and generate an app for you:
37+
38+
1. In **Apps**, click **Create App** in the upper right corner.
39+
40+
2. Select **Plan & Build with Maia**.
41+
42+
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:
43+
44+
* Describe your goals.
45+
* Describe your targeted users.
46+
* List out success criteria.
47+
* Add requirements.
48+
* Attach documents, sketches, images.
49+
50+
4. Click **Generate Plan**. The **Project Scope** window is displayed, and Maia starts populating it with the proposed project scope. Once populated, you can see the following information generated by Maia:
51+
52+
* **Goal** – A description of what you want to achieve through the app.
53+
You can edit this description.
54+
* **Success Criteria** – A list of criteria by which to measure the success of the app.
55+
You can remove criteria by hovering over them, then clicking the trash can icon.
56+
You can add new criteria by clicking **+ Add New Success Criteria**.
57+
* **Target Users** – Cards corresponding to the app's target users, along with each user's goal.
58+
You can remove users or their goals by hovering over them, then clicking the trash can icon.
59+
You can add users by clicking **+ Add New User**.
60+
You can add user goals by clicking **+ Add New User Goal**.
61+
* **Requirements** – The features that the app must have.
62+
You can remove features by hovering over them, then clicking the trash can icon.
63+
You can add new features by clicking **+ Add New Requirement**.
64+
65+
You can use the pane on the right to chat with Maia about your requirements for the new app.
66+
67+
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**.
68+
69+
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. Once populated, you can see the following information generated by Maia:
70+
71+
* Cards corresponding to each epic which contributes to building the app.
72+
* Stories making up each epic.
73+
You can remove stories by hovering over them, then clicking the trash can icon.
74+
You can click the card itself to see the entire list of stories for an epic in the right side panel. For each story, click the context menu to edit or remove the story.
75+
76+
77+
### Creating an App from a Starter App Template
78+
79+
Follow these steps to use a starter app:
80+
81+
1. In **Apps**, click **Create App** in the upper right corner.
82+
83+
2. Select **Use a Starter App**. A screen opens to guide you through the process.
84+
85+
3. Enter the following information for your app:
2886

2987
* **App name** – Every app must have a name that abides by these requirements:
3088

@@ -36,15 +94,15 @@ Follow these steps to create a new app and start collaborating:
3694

3795
* **App icon** – Mendix has generated an icon for your app. You can change the color of the icon if you like. You can upload a custom icon in the [App Settings](/developerportal/general-settings/#general) page once you have created the app.
3896

39-
3. Click **Next** to go to step 2.
97+
4. Click **Next** to go to step 2.
4098

41-
4. Select a starter app template on which the app will be based. The most used starter app templates are displayed.
99+
5. Select a starter app template on which the app will be based. The most used starter app templates are displayed.
42100

43101
Some templates offer multiple versions for you to choose from, which are displayed as selectable options. By default, the stable version is pre-selected.
44102

45103
If you want to choose a different starter app template than the ones displayed, click the **discover community starter apps** link at the top. This takes you to the Marketplace, where you can browse through all available starter app templates and select one that suits your needs.
46104

47-
5. After selecting a starter app template, click **Create App**. Based on the starter app template you selected, it can take some time to set up the app, its repository, and access to the collaboration tools. After it is completed, the app is created.
105+
6. After selecting a starter app template, click **Create App**. Based on the starter app template you selected, it can take some time to set up the app, its repository, and access to the collaboration tools. After it is completed, the app is created.
48106

49107
## My Apps {#my-apps}
50108

0 commit comments

Comments
 (0)