diff --git a/content/en/docs/developerportal/maia-plan.md b/content/en/docs/developerportal/maia-plan.md index f02dd1eb16e..8a8f261c921 100755 --- a/content/en/docs/developerportal/maia-plan.md +++ b/content/en/docs/developerportal/maia-plan.md @@ -7,31 +7,43 @@ weight: 3 ## Introduction -Maia Plan helps you 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 start app development. +Maia Plan helps you 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 start building your app. {{< figure src="/attachments/developerportal/maia/maia-create-app.png" alt="Plan and build with Maia entry point" max-width=50% >}} ## Creating an App with Maia Plan -Follow the steps in the following sections to create an app with Maia Plan. +Follow these steps to get started: -### Adding Project Context +1. In **Apps**, click **Create App** in the upper right corner. +2. Select **Plan & Build**. The **Plan & Build with Maia** window is displayed. +3. Go through the steps in the following sections to create an app with Maia Plan. -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. +### Adding Preliminary Information -1. In **Apps**, click **Create App** in the upper right corner. +Before Maia can generate a plan, provide context about your app and any development guidelines. The more detailed information you provide, the more accurate and aligned the generated plan will be. -2. Select **Plan & Build**. The **Plan & Build with Maia** window is displayed. +#### Adding Project Context + +Project 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. -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: +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: - * Describe your goals. - * Describe your target users. - * List success criteria. - * Add requirements. - * Attach documents, sketches, and images. +* Describe your goals. +* Describe your target users. +* List success criteria. +* Add requirements. +* Attach documents, sketches, and images. -4. Click **Generate Plan**. +#### Adding Company Guidelines + +{{% alert color="info" %}} +This feature is in Public Beta. For more information, refer to [Release Status](/releasenotes/release-status/). +{{% /alert %}} + +In the **Add Company Guidelines** section, add guidelines files to specify the development guardrails and compliance rules that Maia should adhere to while generating your project. + +After you add all relevant project context and company guidelines, click **Generate Plan**. ### Defining the Scope @@ -40,10 +52,9 @@ Work with Maia to refine and detail the project scope, including the goal, succe 1. After you click **Generate Plan**, the **Define Scope** window appears, 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. You can return to the plan at any time after you leave it, and you can add team members to the app. - After the **Define Scope** window is populated, you can see the following information generated by Maia: + After the **Define Scope** window is populated, you can see the following information that Maia generated: - * **Goal** – A description of what you want to achieve with the app. - You can edit this description. + * **Goal** – A description of what you want to achieve with the app. You can edit this description. * **Success Criteria** – A list of criteria to measure the success of the app. You can perform the following actions: @@ -51,7 +62,7 @@ Work with Maia to refine and detail the project scope, including the goal, succe * Remove criteria by hovering over them, then clicking the trash can icon. * Add new criteria by clicking **+Add New Success Criteria**. - * **Target Users** – Cards for the app's target users and each user's goal. You can perform the following actions: + * **Target Users** – Cards that show the app's target users and each user's goal. You can perform the following actions: * Edit user details inline. * Remove users or their goals by hovering over them, then clicking the trash can icon. @@ -64,7 +75,10 @@ Work with Maia to refine and detail the project scope, including the goal, succe * Remove features by hovering over them, then clicking the trash can icon. * Add new features by clicking **+Add New Requirement**. - You can use the pane on the right to chat with Maia about your requirements for the new app. + You can use the pane on the right to chat with Maia about your requirements for the new app. + + * **Company Guidelines** – The list of company standards, policies, or constraints, as indicated by the guideline files you upload at the beginning of the workflow. + {{% alert color="info" %}}This feature is in Public Beta. For more information, refer to [Release Status](/releasenotes/release-status/).{{% /alert %}} 2. After you review the project scope and make any necessary changes, click **Approve to Generate**. You can also click **Save and Exit** to save all the changes and leave the flow. @@ -73,8 +87,7 @@ Work with Maia to refine and detail the project scope, including the goal, succe Maia translates your defined scope into a concrete plan, which includes a series of epics and stories. -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. - After the **Generate Plan** window is populated, you can see the following information generated by Maia: +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. After the **Generate Plan** window is populated, you can see the following information that Maia generated: * Cards for each epic that contributes to building the app. You can remove epics by hovering over them, then clicking the trash can icon.