Skip to content

Commit 145cd6a

Browse files
committed
Added new info + restructured
1 parent 066e16a commit 145cd6a

7 files changed

Lines changed: 230 additions & 190 deletions

File tree

content/en/docs/developerportal/maia-plan.md

Lines changed: 0 additions & 190 deletions
This file was deleted.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: "Maia Plan"
3+
url: /developerportal/maia-plan/
4+
description: "Describes the process of planning and building an app using Maia."
5+
weight: 1
6+
no_list: false
7+
description_list: true
8+
---
9+
10+
## Introduction
11+
12+
Maia Plan helps you plan and generate an app. The pages in this category describe how to provide project context, review and refine the generated project scope, and approve the solution proposal to start app development.
13+
14+
{{< figure src="/attachments/developerportal/maia/maia-create-app.png" alt="Plan and build with Maia entry point" max-width=50% >}}
15+
16+
## Documents in This Category
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: "Creating an App with Maia Plan"
3+
url: /developerportal/maia-plan/create-app/
4+
description: "Describes the process of creating an app using Maia Plan."
5+
weight: 1
6+
---
7+
8+
## Introduction
9+
10+
Follow the steps in the following pages to create an app with Maia Plan:
11+
12+
1. [Add project context](/developerportal/maia-plan/project-context/). Providing context is the foundation for Maia to build your project plan. Give Maia clear goals, user details, and requirements to generate an accurate app plan.
13+
2. [Define the scope](/developerportal/maia-plan/define-scope/). Work with Maia to refine and detail the project scope, including the goal, success criteria, target users, and requirements.
14+
3. [Generate the plan](/developerportal/maia-plan/generate-plan/). Maia translates your defined scope into a concrete plan, which includes a series of epics and stories.
15+
4. [Start the development](/developerportal/maia-plan/start-development/). Organize and start working on user stories.
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: "Defining the Scope"
3+
url: /developerportal/maia-plan/define-scope/
4+
description: "Describes the scope definition step of creating an app with Maia Plan."
5+
weight: 20
6+
---
7+
8+
## Introduction
9+
10+
Work with Maia to refine and detail the project scope, including the goal, success criteria, target users, and requirements.
11+
12+
1. After you click **Generate Plan**, the **Define Scope** window appears, and Maia starts populating it with the proposed project scope.
13+
The app plan becomes available on the **Apps** page as soon as you click **Generate Plan** at the beginning of the workflow. You can return to the plan at any time after you leave it, and you can add team members to the app.
14+
15+
After the **Define Scope** window is populated, you can see the following information generated by Maia:
16+
17+
* **Goal** – A description of what you want to achieve with the app.
18+
You can edit this description.
19+
20+
* **Success Criteria** – A list of criteria to measure the success of the app. You can perform the following actions:
21+
22+
* Edit criteria inline.
23+
* Remove criteria by hovering over them, then clicking the trash can icon.
24+
* Add new criteria by clicking **+Add New Success Criteria**.
25+
26+
* **Target Users** – Cards for the app's target users and each user's goal. You can perform the following actions:
27+
28+
* Edit user details inline.
29+
* Remove users or their goals by hovering over them, then clicking the trash can icon.
30+
* Add users by clicking **+Add New User**.
31+
* Add user goals by clicking **+Add New User Goal**.
32+
33+
* **Requirements** – The features that the app must have. You can perform the following actions:
34+
35+
* Edit requirements inline.
36+
* Remove features by hovering over them, then clicking the trash can icon.
37+
* Add new features by clicking **+Add New Requirement**.
38+
39+
You can use the pane on the right to chat with Maia about your requirements for the new app.
40+
41+
2. After you review the project scope and make any necessary changes, click **Approve to Generate**.
42+
You can also click **Save and Exit** to save all the changes and leave the flow.
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
title: "Generating the Plan"
3+
url: /developerportal/maia-plan/generate-plan/
4+
description: "Describes the plan generation step of creating an app with Maia Plan."
5+
weight: 30
6+
---
7+
8+
## Introduction
9+
10+
Maia translates your defined scope into a concrete plan, which includes a series of epics and stories.
11+
12+
1. After you click **Approve to Generate**, the **Generate Plan** window appears, and Maia starts populating it with the proposed plan based on the project scope.
13+
After the **Generate Plan** window is populated, you can see the following information generated by Maia:
14+
15+
* Cards for each epic that contributes to building the app.
16+
You can remove epics by hovering over them, then clicking the trash can icon.
17+
Click the card to:
18+
19+
* See the list of stories for an epic in the right side panel.
20+
* Edit the description or details of the epic.
21+
22+
You can perform the following actions on each story:
23+
24+
* To see the full details of a story or edit it, click the three-dot menu, then select **Edit**.
25+
* To remove a story, click the three-dot menu, then select **Delete**.
26+
27+
2. While the project plan is being generated, you have these options:
28+
29+
* **Previous** – Click this button to return to the **Define Scope** window. Any changes you have made are saved.
30+
* **Save and Exit** – Save all the changes and leave the flow.
31+
32+
After the project plan is fully generated and you have made any necessary changes, click **Start Building**.
33+
34+
### Recommended Marketplace Components {#recommender}
35+
36+
{{% alert color="warning" %}}
37+
This feature is in Public Beta. For more information, refer to [Release Status](/releasenotes/release-status/).
38+
{{% /alert %}}
39+
40+
Maia identifies approved Marketplace components that can accelerate your development. If Maia finds components that can help you implement a specific story, they are displayed in the following places:
41+
42+
* At the epic level, as a number. Example: *1 Resource*.
43+
* At the user story level, in the side panel. From here, you can perform the following actions:
44+
45+
* If you want more details about the component, click it to access its page in the Marketplace.
46+
* If you do not want a component to be used, delete it by clicking the trash can icon.
47+
48+
If your company has company-approved components, Maia only returns company-approved components from the Public and Private Marketplace.
49+
If your company does not have company-approved components, Maia returns the following types of components:
50+
51+
* Platform-supported components
52+
* All Private Marketplace components
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: "Adding Project Context"
3+
url: /developerportal/maia-plan/project-context/
4+
description: "Describes the project context step of creating an app with Maia Plan."
5+
weight: 10
6+
---
7+
8+
## Introduction
9+
10+
Providing context is the foundation for Maia to build your project plan. Give Maia clear goals, user details, and requirements to generate an accurate app plan.
11+
12+
1. In **Apps**, click **Create App** in the upper right corner.
13+
14+
2. Select **Plan & Build**. The **Plan & Build with Maia** window is displayed.
15+
16+
3. In the **Project Context** text box, enter as much detail as possible about your app. Include the following information to help Maia generate an accurate app plan:
17+
18+
* Describe your goals.
19+
* Describe your target users.
20+
* List success criteria.
21+
* Add requirements.
22+
* Attach documents, sketches, and images.
23+
24+
4. Click **Generate Plan**.

0 commit comments

Comments
 (0)