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
2 changes: 1 addition & 1 deletion content/en/docs/control-center/maia/maia-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ weight: 20
The Maia **Resources** page allows you to increase the capacity of Maia Units for using Maia Make in Studio Pro. From here, you can provision, upgrade, downgrade, and deprovision Maia Units and manage the resources for Maia Make for your company. For more information on Maia Make’s capabilities, see [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/).

{{% alert color="info" %}}
Maia Units are only required for Maia Make. Other Maia features (for example, Maia Plan) do not require Maia Units.
Maia Units are only required for Maia Make. Other Maia features (for example, Maia Spec) do not require Maia Units.
{{% /alert %}}

## Prerequisites
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/developerportal/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The following sections describe the process for each option.

### Creating an App with Maia

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

### Creating an App from a Starter App Template

Expand Down
10 changes: 6 additions & 4 deletions content/en/docs/developerportal/maia-plan/_index.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
---
title: "Maia Plan"
url: /developerportal/maia-plan/
title: "Maia Spec"
url: /developerportal/maia-spec/
description: "Describes the process of planning and building an app using Maia."
weight: 1
no_list: false
description_list: true
aliases:
- /developerportal/maia-plan/
---

## Introduction

Maia Plan helps you create a detailed project plan, based on which you can then generate your app with [Maia Make](/refguide/maia-make/). 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.
Maia Spec helps you create a detailed project plan, based on which you can then generate your app with [Maia Make](/refguide/maia-make/). 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% >}}

Maia Plan covers the planning stage of the application lifecycle. You can use the stories from the plan as input when building your app in Studio Pro with Maia Make, or have external AI agents read the plan through [Maia Plan as MCP Server](/developerportal/maia-plan-mcp/). For an overview of how Maia supports each stage, see [Maia Across the Development Lifecycle](/refguide/maia-development-lifecycle/).
Maia Spec covers the planning stage of the application lifecycle. You can use the stories from the plan as input when building your app in Studio Pro with Maia Make, or have external AI agents read the plan through [Maia Spec as MCP Server](/developerportal/maia-plan-mcp/). For an overview of how Maia supports each stage, see [Maia Across the Development Lifecycle](/refguide/maia-development-lifecycle/).

## Documents in This Category
18 changes: 10 additions & 8 deletions content/en/docs/developerportal/maia-plan/create-app/_index.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
---
title: "Creating an App with Maia Plan"
url: /developerportal/maia-plan/create-app/
description: "Describes the process of creating an app using Maia Plan."
title: "Creating an App with Maia Spec"
url: /developerportal/maia-spec/create-app/
description: "Describes the process of creating an app using Maia Spec."
weight: 1
aliases:
- /developerportal/maia-plan/create-app/
---

## Introduction

Follow the steps in the following pages to create an app with Maia Plan:
Follow the steps in the following pages to create an app with Maia Spec:

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.
1. [Add project context](/developerportal/maia-spec/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-spec/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-spec/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-spec/start-development/). Organize and start working on user stories.
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
---
title: "Defining the Scope"
url: /developerportal/maia-plan/define-scope/
description: "Describes the scope definition step of creating an app with Maia Plan."
url: /developerportal/maia-spec/define-scope/
description: "Describes the scope definition step of creating an app with Maia Spec."
weight: 20
aliases:
- /developerportal/maia-plan/define-scope/
---

## 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.
1. After you click **Create Plan**, the **Define Scope** window appears, and Maia starts populating it with the proposed project scope.
The app plan becomes available on the **Projects** 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:
Expand Down Expand Up @@ -38,5 +40,5 @@ Work with Maia to refine and detail the project scope, including the goal, succe

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 & Generate**.
You can also click **Save and Exit** to save all the changes and leave the flow.
2. After you review the project scope and make any necessary changes, click **Create Specs**. This prompts Maia to start turning your input into a detailed set of specs, with each spec mapping to each distinct capability.
You can also click **Save** to save all the changes and leave the flow.
Original file line number Diff line number Diff line change
@@ -1,35 +1,27 @@
---
title: "Generating the Plan"
url: /developerportal/maia-plan/generate-plan/
description: "Describes the plan generation step of creating an app with Maia Plan."
url: /developerportal/maia-spec/generate-plan/
description: "Describes the plan generation step of creating an app with Maia Spec."
weight: 30
aliases:
- /developerportal/maia-plan/generate-plan/
---

## Introduction

Maia translates your defined scope into a concrete plan, which includes a series of epics and stories.
Maia translates your defined scope into a concrete set of specs, where each spec corresponds to a specific capability.

1. After you click **Approve & 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**.
1. After you click **Create Specs**, the **Spec** window appears, and Maia starts populating it with the proposed specs based on the project scope. The generated specs are listed in the left-hand pane. Each spec is made up of several requirements. For project management purposes, a spec corresponds to an epic, and a requirement corresponds to a story.

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**.
After the project plan is fully generated and you have made any necessary changes, click one of the available options:

* **Open in Jira** – Start managing the project in Jira.
* **Build in Maia Make** – Open the project in Studio Pro's Maia Make.

### Recommended Marketplace Components {#recommender}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
---
title: "Adding Project Context"
url: /developerportal/maia-plan/project-context/
description: "Describes the project context step of creating an app with Maia Plan."
url: /developerportal/maia-spec/project-context/
description: "Describes the project context step of creating an app with Maia Spec."
weight: 10
aliases:
- /developerportal/maia-plan/project-context/
---

## Introduction
Expand All @@ -27,4 +29,6 @@ Providing context is the foundation for Maia to build your project plan. Give Ma
* **Use the latest version**
* **Use a starter app with a predefined Studio Pro version**

5. Click **Generate Plan**.
5. Click **Create Plan**.

Maia analyzes the context in the background, and starts producing a scope.
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
---
title: "Starting the Development"
url: /developerportal/maia-plan/start-development/
description: "Describes the development step of creating an app with Maia Plan."
url: /developerportal/maia-spec/start-development/
description: "Describes the development step of creating an app with Maia Spec."
weight: 40
aliases:
- /developerportal/maia-plan/start-development/
---

## Introduction
Expand All @@ -15,20 +17,20 @@ After you click **Start Building**, the **Start Development** window is displaye
* **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.
If you start prioritizing your work before Maia is done [finding recommendations](/developerportal/maia-spec/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).
* **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-spec/generate-plan/#recommender).

For details, refer to [Maia Make](/refguide/maia-make/) in the Studio Pro documentation.

## Connecting Maia Plan to Jira {#connect-jira}
## Connecting Maia Spec 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.
The following two sections describe the two main actions you need to take to use Jira as your project management tool in Maia Spec.

### Configuring Jira for Maia Plan
### Configuring Jira for Maia Spec

Follow these steps to configure Jira for use with Maia Plan.
Follow these steps to configure Jira for use with Maia Spec.

New Jira projects/spaces:

Expand All @@ -44,7 +46,7 @@ New Jira projects/spaces:
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.
2. Select the board you want to use with Maia Spec, or create a new one.
3. Ensure the board includes a filter for the project's Jira key:

* For an existing board:
Expand All @@ -53,13 +55,13 @@ Existing Jira projects/spaces:
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 %}}
{{% 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 Spec. {{% /alert %}}

### Configuring Maia Plan for Jira
### Configuring Maia Spec 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:
Follow these steps to connect Maia Spec to Jira:

1. In the **Connect Planning Tool** window, select **Jira**.
2. Fill in the information as follows:
Expand All @@ -70,12 +72,12 @@ Follow these steps to connect Maia Plan to Jira:
* **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
## Using Jira with Maia Spec

After you connect Maia Plan to Jira, you can use Jira as your project management tool:
After you connect Maia Spec 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 %}}
1. In Maia Spec, 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 Spec. Your epics and stories are displayed in the Jira backlog.
{{% alert color="warning" %}} The redirection from Maia Spec 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 Spec. {{% /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.
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
title: "Creating an App from a Starter App"
url: /developerportal/maia-plan/using-starter-app/
description: "Describes how to use a starter app to create an app in Maia Plan."
url: /developerportal/maia-spec/using-starter-app/
description: "Describes how to use a starter app to create an app in Maia Spec."
weight: 50
beta: true
aliases:
- /developerportal/maia-plan/using-starter-app/
---

{{% alert color="info" %}}
Expand All @@ -12,7 +14,7 @@ This feature is currently in beta. For more information, refer to [Release Statu

## Introduction

You can use a starter app as the basis for Maia Plan to build a project plan. This allows you to use the right branding elements, pre-installed Marketplace modules, and pre-installed integrations.
You can use a starter app as the basis for Maia Spec to build a project plan. This allows you to use the right branding elements, pre-installed Marketplace modules, and pre-installed integrations.

## Creating an App

Expand All @@ -33,8 +35,8 @@ Follow these steps to have Maia create a project plan based on a starter app:

6. Click **Generate Plan**. This starts the project creation flow. The starter app that's used for the project is displayed in the top bar of the window, just under the project's name.

7. Define the project scope as described in [Defining the Scope](/developerportal/maia-plan/define-scope/). With starter apps, Maia brings in all existing information to the **Define Scope** window.
7. Define the project scope as described in [Defining the Scope](/developerportal/maia-spec/define-scope/). With starter apps, Maia brings in all existing information to the **Define Scope** window.

8. Turn the project scope into a concrete plan, as described in [Generating the Plan](/developerportal/maia-plan/generate-plan/). The side panel displays the resources which are being used from the starter app.
8. Turn the project scope into a concrete plan, as described in [Generating the Plan](/developerportal/maia-spec/generate-plan/). The side panel displays the resources which are being used from the starter app.

9. Select your project management tool and send your project plan to Maia Make, as described in [Starting the Development](/developerportal/maia-plan/start-development/).
9. Select your project management tool and send your project plan to Maia Make, as described in [Starting the Development](/developerportal/maia-spec/start-development/).
Loading