Maia Plan Jira

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

@@ -0,0 +1,16 @@
+---
+title: "Maia Plan"
+url: /developerportal/maia-plan/
+description: "Describes the process of planning and building an app using Maia."
+weight: 1
+no_list: false
+description_list: true
+---
+
+## Introduction
+
+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.
+
+{{< figure src="/attachments/developerportal/maia/maia-create-app.png" alt="Plan and build with Maia entry point" max-width=50% >}}
+
+## Documents in This Category

content/en/docs/developerportal/maia-plan/create-app/_index.md

@@ -0,0 +1,15 @@
+---
+title: "Creating an App with Maia Plan"
+url: /developerportal/maia-plan/create-app/
+description: "Describes the process of creating an app using Maia Plan."
+weight: 1
+---
+
+## Introduction
+
+Follow the steps in the following pages to create an app with Maia Plan:
+
+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.
+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.
+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.
+4. [Start the development](/developerportal/maia-plan/start-development/). Organize and start working on user stories.

content/en/docs/developerportal/maia-plan/create-app/define-scope.md

@@ -0,0 +1,42 @@
+---
+title: "Defining the Scope"
+url: /developerportal/maia-plan/define-scope/
+description: "Describes the scope definition step of creating an app with Maia Plan."
+weight: 20
+---
+
+## Introduction
+
+Work with Maia to refine and detail the project scope, including the goal, success criteria, target users, and requirements.
+
+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:
+
+    * **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:  
+
+        * Edit criteria inline.
+        * 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:   
+
+        * Edit user details inline.
+        * Remove users or their goals by hovering over them, then clicking the trash can icon.    
+        * Add users by clicking **+Add New User**.    
+        * Add user goals by clicking **+Add New User Goal**.
+
+    * **Requirements** – The features that the app must have. You can perform the following actions:
+
+        * Edit requirements inline.
+        * 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.
+
+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.

content/en/docs/developerportal/maia-plan/create-app/generate-plan.md

@@ -0,0 +1,52 @@
+---
+title: "Generating the Plan"
+url: /developerportal/maia-plan/generate-plan/
+description: "Describes the plan generation step of creating an app with Maia Plan."
+weight: 30
+---
+
+## Introduction
+
+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:
+
+    * Cards for each epic that contributes to building the app.    
+        You can remove epics by hovering over them, then clicking the trash can icon.    
+        Click the card to:
+
+        * See the 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:
+
+        * To see the full details of a story or edit it, click the three-dot menu, then select **Edit**.    
+        * To remove a story, click the three-dot menu, then select **Delete**.
+
+2. While the project plan is being generated, you have these options:
+
+    * **Previous** – Click this button to return to the **Define Scope** window. Any changes you have made are saved.
+    * **Save and Exit** – Save all the changes and leave the flow.
+
+   After the project plan is fully generated and you have made any necessary changes, click **Start Building**.
+
+### Recommended Marketplace Components {#recommender}
+
+{{% alert color="warning" %}}
+This feature is in Public Beta. For more information, refer to [Release Status](/releasenotes/release-status/).
+{{% /alert %}}
+
+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:
+
+* 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.
+
+If your company has company-approved components, Maia only returns company-approved components from the Public and Private Marketplace.    
+If your company does not have company-approved components, Maia returns the following types of components:
+
+* Platform-supported components
+* All Private Marketplace components

content/en/docs/developerportal/maia-plan/create-app/project-context.md

@@ -0,0 +1,24 @@
+---
+title: "Adding Project Context"
+url: /developerportal/maia-plan/project-context/
+description: "Describes the project context step of creating an app with Maia Plan."
+weight: 10
+---
+
+## Introduction
+
+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.
+
+1. In **Apps**, click **Create App** in the upper right corner.
+
+2. Select **Plan & Build**. The **Plan & Build with Maia** window is displayed.
+
+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:
+
+    * Describe your goals.
+    * Describe your target users.
+    * List success criteria.
+    * Add requirements.
+    * Attach documents, sketches, and images.
+
+4. Click **Generate Plan**.

content/en/docs/developerportal/maia-plan/create-app/start-development.md

@@ -0,0 +1,81 @@
+---
+title: "Starting the Development"
+url: /developerportal/maia-plan/start-development/
+description: "Describes the development step of creating an app with Maia Plan."
+weight: 40
+---
+
+## Introduction
+
+After you click **Start Building**, the **Start Development** window is displayed, showing the following options:
+
+* **Prioritize** – Click the **Connect Planning Tool** button in the **Prioritize** section to select the project management tool you want to use for organizing and planning your work. This opens the **Connect Planning Tool** window, where you can select one of these options:
+
+    * **Mendix Planning Board (default)** – Use the Mendix planning board, where you can reorganize the sprints as needed.     
+    * **Jira** – Use Jira to organize and prioritize your work. To do that, follow the steps in the [Connecting to Jira](#connect-jira) section.  
+
+   {{% alert color="info" %}}
+   If you start prioritizing your work before Maia is done [finding recommendations](/developerportal/maia-plan/generate-plan/#recommender), recommended components are not displayed in the **Planning** window.
+   {{% /alert %}}
+
+* **Build** – Click the **Open in Studio Pro** button in the **Build** section to open Studio Pro, where you can continue working on the new app. Studio Pro does not currently take into account [recommended components](/developerportal/maia-plan/generate-plan/#recommender).
+
+    For details, refer to [Maia Make](/refguide/maia-make/) in the Studio Pro documentation.    
+
+## Connecting Maia Plan to Jira {#connect-jira}
+
+The following two sections describe the two main actions you need to take to use Jira as your project management tool in Maia Plan.
+
+### Configuring Jira for Maia Plan
+
+Follow these steps to configure Jira for use with Maia Plan.
+
+New Jira projects/spaces:
+
+1. Create a new Jira project/space.
+2. Ensure that the default board has the correct project filter. To do that, follow these steps:
+
+    1. Find your **Project key** or **Space key**. The project key is the short code that Jira assigns to your project. You can find it next your project name, in the top left corner of your Jira project. It is also available in the **Project Settings** window, which you can access from the context menu of your project.
+        {{< figure src="/attachments/developerportal/maia/space-key.png" alt="Board key field in Jira" max-width="30%" >}}
+    2. Click **Board Settings** in the context menu of your board.
+        {{< figure src="/attachments/developerportal/maia/board-settings-option.png" alt="Board Settings button in Jira" max-width="30%" >}}
+    3. Set the filter to *project = "your project key"*. 
+
+Existing Jira projects/spaces:
+
+1. Open your existing Jira project/space.
+2. Select the board you want to use with Maia Plan, or create a new one.
+3. Ensure the board includes a filter for the project's Jira key:
+
+    * For an existing board:
+
+        1. Open **Board Settings**.
+        2. Confirm that the filter is set to *project = "your project key"*.
+
+    * For a new board, select **All work items from your space**.     
+        {{% alert color="info" %}} When you select **All work items from your space**, a consolidated backlog view is created. This view includes work items from all boards in the project, not just those managed through Maia Plan. {{% /alert %}}
+
+### Configuring Maia Plan for Jira
+
+Before you begin, make sure that the [prerequisites for using Jira](/developerportal/project-management/jira-connector/#prerequisites) are met.
+
+Follow these steps to connect Maia Plan to Jira:
+
+1. In the **Connect Planning Tool** window, select **Jira**.
+2. Fill in the information as follows:
+
+    * **Base URL Jira Environment** – The URL of your company’s environment within the Jira platform, as provided by Jira. This URL usually looks like this: `https://my-company.atlassian.net`.
+    * **Project Key** – The unique key of your project/space within the Jira platform.
+    * **Board ID** – The unique number that identifies a specific board in your Jira project/space.
+    * **Jira Account** – The login name of a user on the Jira platform with project administration rights.
+    * **API Token** – A valid API token issued by the Jira platform and assigned to the admin user mentioned above. For more information on how to get this API token, refer to [Manage API tokens for your Atlassian account](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/).    
+
+## Using Jira with Maia Plan
+
+After you connect Maia Plan to Jira, you can use Jira as your project management tool:
+
+1. In Maia Plan, in the **Start Development** window, set the planning tool to Jira, as previously indicated.
+2. Click **Open Jira** to open the connected Jira board from Maia Plan. Your epics and stories are displayed in the Jira backlog.    
+     {{% alert color="warning" %}} The redirection from Maia Plan to team-managed project boards is not currently working as expected. To see your team-managed project board, you need to have the correct URL yourself. This issue does not occur for company-managed project boards, which open correctly from Maia Plan. {{% /alert %}}
+3. If an active sprint does not already exist, create one in Jira.
+4. Move the stories you want to work on from the backlog into the active sprint. The stories in the active sprint are now also available in Studio Pro.