diff --git a/src/content/docs/advanced/ai-powered-features/ai-requirements.md b/src/content/docs/advanced/ai-powered-features/ai-requirements.md index ea9edcf9..9f6059e0 100644 --- a/src/content/docs/advanced/ai-powered-features/ai-requirements.md +++ b/src/content/docs/advanced/ai-powered-features/ai-requirements.md @@ -13,7 +13,14 @@ head: ## AI-Powered Requirements Testomat.io introduces another AI-powered feature - **AI-Requirements** that helps to streamline test coverage alignment with product requirements. -When you link a Jira issue as a requirement in Testomat.io, the system will analyze the issue’s description and automatically suggest a structured requirement description. Based on the analysis, you’ll be offered two intelligent options: + +A dedicated **'Requirements'** page brings all your requirements into a single, convenient workspace, allowing you to view, organize, and update requirements in one place — without jumping across different parts of the project. + +When you add a **Requirement source** (Jira issue, Confluence page, PDF file, etc.) in Testomat.io, the system will analyze it's description and automatically suggest a structured requirement summary. Also, by clicking on the requirement, you can check all suites linked to it, requirement source and added attachments. + +![Testomat.io - AI-powered](./images/Requirement_page_details_1.gif) + +**Based on the requirement analysis, you’ll be offered two intelligent options:** - Generate a new test suite with suggested test cases. - Analyze existing suites and suggest test coverage improvements. @@ -26,8 +33,6 @@ This feature is available both at the **project level** and within individual ** - Ensures traceability and alignment between business goals and test coverage. - Reduces manual effort and potential gaps in test planning. -![Testomat.io - AI-powered](./images/AI_10.gif) - :::note By default, AI-powered generative features are disabled for your confidence. @@ -35,53 +40,101 @@ You can enbable AI at any time on Company Settings page by following the instruc ::: +# Requirements Page Overview + +**On 'Requirements' page you can:** + +1. Link new requirement (check ['Add Requirements to a Project'](https://docs.testomat.io/advanced/ai-powered-features/ai-requirements/#add-requirements-to-a-project) section for more details). +2. Filter requirements by sourse type, level and status. +3. Search for the information inside the requirements. +4. Change the **Requirements Display** view (check section below for more information). +5. Use AI feature **'Chat with Requirements'**. +6. View **'Requirement details'** page. +7. Edit Requirement. +8. Delete Requirement. + +![Testomat.io - Requirements page](./images/Req_page_1.png) + +### Requirements Display View + +**Select the requirements display view based on your needs:** + +- **'Display as List':** allows you to work with requirements on the **Requirements level**. All the requirements are displayed in one list. In this view you can view requirement details, link suites to the selected requirement, add attachments or requirement notes. + +- **'Display by Suites':** allows you to work with the requirements on the **Suites level**. All the suites are displayed in one list with the requirements linked to each suite. In this view you can see what suites don't have any requirements linked, what requirements are added to the specific suite and check if nothing was missed, you can attach/detach the requirement to the selected suite and as well change the requirement details. + ## Add Requirements to an Empty Project You can start a new project by first adding your requirements. Once a project is created (BDD or Classical), set up the integration for your **Requirement Source** (see detailed instructions for [JIRA](https://docs.testomat.io/integrations/issues-management/jira/#connecting-to-jira-project) and [Confluence](https://docs.testomat.io/integrations/issues-management/confluence)). Then, proceed with adding requirements: -1. Click **'Extra menu'** button. -2. Select **'Requirements'** option from the dropdown list. +1. Open **'Requirements'** page. +2. Click **'+New Requirements'** or **'+Add Requirement'** button. -![Testomat.io - Empty Project](./images/Empty_Project_1.png) +![Testomat.io - Empty Project](./images/Req_empty_project_1.png) -3. Click **'+ Add'** button -4. Select your requirement source (Jira in our case). -5. Enter **'Jira Issue ID'**. -6. Click **'Save'** button. +3. Select your requirement source (Jira in our case). +4. Enter **'Jira Issue ID'**. +5. Click **'Save'** button. -![Testomat.io - Empty Project](./images/Empty_Project_2.png) +![Testomat.io - Empty Project](./images/Req_empty_project_2.png) After the requirement is linked to Testomat.io you can use AI Assistant to analyze requirements for edge cases and potential solutions. You can also create suites and test cases based on these requirements. +:::note + +You can add a new requirement to your ongoing project any time following the same steps. + +::: + +## Link Requirement to an Existing Suite Case + +Testomat.io allows you to link a requirement that was already added to the Project to an existing suite case directly from its page. To do that, follow these steps: + +1. Open your Suite Case. +2. Click **'Extra menu'** button. +3. Select **'Requirements'** option from the dropdown list. +4. Open **'All Requirements'** tab. +5. Select the requirement that you want to link to the Suite from the list by clicking on **'Attach'** button. + +![Testomat.io - Link Requirements](./images/Requirements_1.gif) + +To unlink the requirement from the suite, follow Steps 1-3 and on **'Attached to suite'** or **'All Requirements'** tab click **'Detach'** button for requirement that you want to unlink. + +![Testomat.io - Unlink Requirements](./images/Unlink_Requirement_1.png) + ## Jira as a Requirement Source Testomat.io not only allows you to start a new project with requirements but also to link requirements to an ongoing project at any time. **To add Jira as a Requirement Source:** -1. Open your Project in Testomat.io. -2. Click **'Extra menu'** button. -3. Select **'Requirements'** option from the dropdown list. -4. Click **'+ Add'** button. -5. Select **'Jira'** as your Requirement Source. -6. Enter **'Jira Issue ID'**. -7. Click **'Save'** button. +1. Open your Project in Testomat.io. +2. Go to **'Requirements'** page. +3. Click **'+Add Requirement'** button. + +OR -![Testomat.io - AI-powered](./images/AI_Jira_1.gif) +Access **'Requirements'** page via **'Extra menu'** button on **'Tests'** page. + +4. Select **'Jira'** as your Requirement Source. +5. Enter **'Jira Issue ID'**. +6. Click **'Save'** button. + +![Testomat.io - AI-powered](./images/AI_Jira_Req_1.gif) Same as for a new project, after the requirement is linked to your project, you can start using AI-features for analyzing it, and generating suites, test cases, and edge cases to cover your requirements. :::note -To use AI-Requirements feature, first connect Testomat.io to your Jira project. See detailed instructions in the [Connecting to JIRA project](https://docs.testomat.io/integrations/issues-management/jira/#connecting-to-jira-project) section. +To use AI-Requirements feature, first connect Testomat.io to your Jira project. See detailed instructions in the ['Connecting to JIRA project'](https://docs.testomat.io/integrations/issues-management/jira/#connecting-to-jira-project) section. ::: ## Confluence as a Requirement Source -Testomat.io allows you to use your Confluence space as a source of requirements. First, connect your Confluence space to your Testomat.io project, similar to setting up Jira. For detailed setup instructions, refer to the [Confluence section](https://docs.testomat.io/integrations/issues-management/confluence). +Testomat.io allows you to use your Confluence space as a source of requirements. First, connect your Confluence space to your Testomat.io project, similar to setting up Jira. For detailed setup instructions, refer to the ['Confluence'](https://docs.testomat.io/integrations/issues-management/confluence) section. Once connected, the system can analyze your Confluence pages to extract requirement descriptions, assess traceability, identify edge cases, and generate relevant test suites and test cases. @@ -89,18 +142,141 @@ This integration bridges the gap between documentation and test planning, enabli **To add Confluence as a Requirement into your project:** -1. Click **'Extra menu'** button. -2. Select **'Requirements'** option from the dropdown list. -3. Click **'+ Add'** button. -4. Select **'Confluence'** as your Requirement Source. -5. Enter **'Confluence page url'**. +1. Go to **'Requirements'** page. +2. Click **'+Add Requirement'** button. + +OR + +Access **'Requirements'** page via **'Extra menu'** button on **'Tests'** page. + +3. Select **'Confluence'** as your Requirement Source. +4. Enter **'Confluence page url'**. +5. Click **'Save'** button. + +![Testomat.io - Confluence](./images/Confluence_Req_1.gif) + +## Files & Text as a Requirement Source + +Testomat.io allows you to use not only Jira or Confluence as a Requirement Source, but also add text files, docs, spreadsheets or even screenshots and images. + +**Supported sources include:** + +- **Files** — PDF, DOCX, XLSX, CSV, TXT, Markdown, and others. +- **Plain text** — paste any text and instantly convert it into structured requirements. + +This makes it much easier to import requirements from PRDs, customer documentation, spreadsheets, briefs, or any internal artifacts your team already uses. + +**To add requirement:** + +1. Go to **'Requirements'** page. +2. Click **'+Add Requirement'** button. + +![Testomat.io - Files & Text as a Requirement Source](./images/Add_file_req_1.png) + +- **To add a file as a requirement source:** +3. Select **'File'**. +4. Enter **Title**. +5. Upload any file in allowed format via **'Browse a file'**. 6. Click **'Save'** button. -![Testomat.io - Confluence](./images/Confluence_3.gif) +![Testomat.io - Files & Text as a Requirement Source](./images/Add_file_req_2.png) + +- **To add a plain text as a requirement source:** +3. Select **'Text'**. +4. Enter **Title**. +5. Add **Description**. +6. Click **'Save'** button. + +:::note + +**Minimum 500 characters** is required for **Text requirement**. +You can add images and other files to this requirement after saving. + +::: + +![Testomat.io - Files & Text as a Requirement Source](./images/Add_file_req_3.png) + +## Global Requirements Setup + +If you set up **Requirements as Global** on a **Project level**, it will allow the system to automatically attach selected requirements to **every newly created test** inside the project. +This is especially useful for teams working with mandatory compliance rules, overarching documentation, or project-wide standards that must be reflected in all tests. + +**To set up Requirements as Global:** + +1. Go to **'Requirements'** page. +2. Select a Requirement you want to set up as global. +3. Click **'Extra menu'** button. +4. Select **'Make Global'** option. + +![Testomat.io - Requirements as Global](./images/Global_req_1.png) + +This ensures consistency and saves time by eliminating repeated manual assignment. + +:::note + +To set up the **Requirement as Global** it should not be linked to any Suites. + +![Testomat.io - Requirements as Global](./images/Global_req_2.png) + +::: + +## AI-Powered Image Understanding for Requirements + +With this feature you can attach images directly to your requirements, and AI will automatically analyze them and include their content in the requirement summary. This enriched summary is then used during test generation, ensuring that visual details are not missed. + +:::note + +All the attachments added to the requirements are also automatically added to the suites and test cases created from these requirements and displayed in the **'Attachments'** tab. + +::: + +![Testomat.io - Image Source](./images/Image_req_1.gif) + +The same behavior now applies to **Jira- and Confluence-based requirements**: +if your Jira ticket or Confluence page includes attachments (images, diagrams, files), Testomat.io will import them, analyze them, and enrich the requirements summary — giving you more accurate AI-generated tests. + +The requirements created based on the attached image will be displayed on **'Summary'** tab under main requirements details in the **'Attached Image'** section. + +![Testomat.io - Image Source](./images/Image_req_2.png) + +## Edit Linked Requirements + +The original requirement cannot be edited inside Testomat.io, as it comes from an external source. But you can clarify any missing details from the original requirement or add some notes: + +1. Go to **'Requirements'** page. +2. Select the Requirement. +3. Click **'Extra menu'** button. +4. Select **'Edit Requirement Notes'** option. + +![Testomat.io - Edit Linked Requirements](./images/Edit_req_1.png) + +5. Add additional information/edge cases/notes. +6. Click **'Save'** button. + +![Testomat.io - Edit Linked Requirements](./images/Edit_req_2.png) + +After notes are added and saved, they will be displayed on **'Summary'** tab under main requirements details in the **'Requirement Notes'** section. + +![Testomat.io - Edit Linked Requirements](./images/Edit_req_3.png) + +## Refresh the Requirement + +If you added some changes to the original source of your requirement, you would want it to be updated in your Testomat.io Project as well. To resync the requirement you need: + +1. Go to **'Requirements'** page. +2. Open requirement that was updated. +3. Click **'Extra menu'** button. +4. Click **'Refresh Requirement'** option. + +![Testomat.io - Refresh Requirement](./images/Refresh_Requirement_1.png) + +After the refreshment your requirement is automatically updated so you don't need to link the requirement again or update it manually. + +![Testomat.io - Refresh Requirement](./images/Refresh_Requirement_2.gif) ## Analyze Requirements for Edge Cases -1. Open added Requirement. +1. On **'Requirements'** page open added **Requirement**. 2. Click **'Analyze Requirement'** button. ![Testomat.io - Jira](./images/AI_Jira_2.png) @@ -181,17 +357,4 @@ Similar to the previous case, review the suggested test cases, add the relevant All added test cases will be displayed in your Suite after AI-assistant window is closed. -![Testomat.io - Suggest Tests](./images/AI_Suggest_tests_3.png) - -## Link Requirement to an Existing Suite Case - -Testomat.io allows you to link a requirement to an existing suite case directly from suite case page. To do that, follow these steps: - -1. Open your Suite Case. -2. Click **'Extra menu'** button. -3. Select **'Add Requirements'** option from the dropdown list. -4. Select the requirement from the list by clicking on **'Attach'** button. - -![Testomat.io - Requirements](./images/Requirements_1.gif) - -After linking the requirement to your suite case, you can use AI to generate test cases and verify requirement coverage. This will save time and help identify missing or redundant tests. \ No newline at end of file +![Testomat.io - Suggest Tests](./images/AI_Suggest_tests_3.png) \ No newline at end of file diff --git a/src/content/docs/advanced/ai-powered-features/images/AI_10.gif b/src/content/docs/advanced/ai-powered-features/images/AI_10.gif deleted file mode 100644 index 637045c1..00000000 Binary files a/src/content/docs/advanced/ai-powered-features/images/AI_10.gif and /dev/null differ diff --git a/src/content/docs/advanced/ai-powered-features/images/AI_Jira_1.gif b/src/content/docs/advanced/ai-powered-features/images/AI_Jira_1.gif deleted file mode 100644 index 8e4bef92..00000000 Binary files a/src/content/docs/advanced/ai-powered-features/images/AI_Jira_1.gif and /dev/null differ diff --git a/src/content/docs/advanced/ai-powered-features/images/AI_Jira_Req_1.gif b/src/content/docs/advanced/ai-powered-features/images/AI_Jira_Req_1.gif new file mode 100644 index 00000000..5ac06e64 Binary files /dev/null and b/src/content/docs/advanced/ai-powered-features/images/AI_Jira_Req_1.gif differ diff --git a/src/content/docs/advanced/ai-powered-features/images/Add_file_req_1.png b/src/content/docs/advanced/ai-powered-features/images/Add_file_req_1.png new file mode 100644 index 00000000..e3c1d753 Binary files /dev/null and b/src/content/docs/advanced/ai-powered-features/images/Add_file_req_1.png differ diff --git a/src/content/docs/advanced/ai-powered-features/images/Add_file_req_2.png b/src/content/docs/advanced/ai-powered-features/images/Add_file_req_2.png new file mode 100644 index 00000000..47932ae4 Binary files /dev/null and b/src/content/docs/advanced/ai-powered-features/images/Add_file_req_2.png differ diff --git a/src/content/docs/advanced/ai-powered-features/images/Add_file_req_3.png b/src/content/docs/advanced/ai-powered-features/images/Add_file_req_3.png new file mode 100644 index 00000000..552874e9 Binary files /dev/null and b/src/content/docs/advanced/ai-powered-features/images/Add_file_req_3.png differ diff --git a/src/content/docs/advanced/ai-powered-features/images/Confluence_3.gif b/src/content/docs/advanced/ai-powered-features/images/Confluence_3.gif deleted file mode 100644 index 122e9606..00000000 Binary files a/src/content/docs/advanced/ai-powered-features/images/Confluence_3.gif and /dev/null differ diff --git a/src/content/docs/advanced/ai-powered-features/images/Confluence_Req_1.gif b/src/content/docs/advanced/ai-powered-features/images/Confluence_Req_1.gif new file mode 100644 index 00000000..81cf405d Binary files /dev/null and b/src/content/docs/advanced/ai-powered-features/images/Confluence_Req_1.gif differ diff --git a/src/content/docs/advanced/ai-powered-features/images/Edit_req_1.png b/src/content/docs/advanced/ai-powered-features/images/Edit_req_1.png new file mode 100644 index 00000000..cbd16277 Binary files /dev/null and b/src/content/docs/advanced/ai-powered-features/images/Edit_req_1.png differ diff --git a/src/content/docs/advanced/ai-powered-features/images/Edit_req_2.png b/src/content/docs/advanced/ai-powered-features/images/Edit_req_2.png new file mode 100644 index 00000000..b7088b12 Binary files /dev/null and b/src/content/docs/advanced/ai-powered-features/images/Edit_req_2.png differ diff --git a/src/content/docs/advanced/ai-powered-features/images/Edit_req_3.png b/src/content/docs/advanced/ai-powered-features/images/Edit_req_3.png new file mode 100644 index 00000000..f59bce00 Binary files /dev/null and b/src/content/docs/advanced/ai-powered-features/images/Edit_req_3.png differ diff --git a/src/content/docs/advanced/ai-powered-features/images/Empty_Project_1.png b/src/content/docs/advanced/ai-powered-features/images/Empty_Project_1.png deleted file mode 100644 index a0f57c38..00000000 Binary files a/src/content/docs/advanced/ai-powered-features/images/Empty_Project_1.png and /dev/null differ diff --git a/src/content/docs/advanced/ai-powered-features/images/Empty_Project_2.png b/src/content/docs/advanced/ai-powered-features/images/Empty_Project_2.png deleted file mode 100644 index ad25171b..00000000 Binary files a/src/content/docs/advanced/ai-powered-features/images/Empty_Project_2.png and /dev/null differ diff --git a/src/content/docs/advanced/ai-powered-features/images/Global_req_1.png b/src/content/docs/advanced/ai-powered-features/images/Global_req_1.png new file mode 100644 index 00000000..bda40e9f Binary files /dev/null and b/src/content/docs/advanced/ai-powered-features/images/Global_req_1.png differ diff --git a/src/content/docs/advanced/ai-powered-features/images/Global_req_2.png b/src/content/docs/advanced/ai-powered-features/images/Global_req_2.png new file mode 100644 index 00000000..49ff976a Binary files /dev/null and b/src/content/docs/advanced/ai-powered-features/images/Global_req_2.png differ diff --git a/src/content/docs/advanced/ai-powered-features/images/Image_req_1.gif b/src/content/docs/advanced/ai-powered-features/images/Image_req_1.gif new file mode 100644 index 00000000..863e1a56 Binary files /dev/null and b/src/content/docs/advanced/ai-powered-features/images/Image_req_1.gif differ diff --git a/src/content/docs/advanced/ai-powered-features/images/Image_req_2.png b/src/content/docs/advanced/ai-powered-features/images/Image_req_2.png new file mode 100644 index 00000000..92f3e142 Binary files /dev/null and b/src/content/docs/advanced/ai-powered-features/images/Image_req_2.png differ diff --git a/src/content/docs/advanced/ai-powered-features/images/Refresh_Requirement_1.png b/src/content/docs/advanced/ai-powered-features/images/Refresh_Requirement_1.png new file mode 100644 index 00000000..3a42dcef Binary files /dev/null and b/src/content/docs/advanced/ai-powered-features/images/Refresh_Requirement_1.png differ diff --git a/src/content/docs/advanced/ai-powered-features/images/Refresh_Requirement_2.gif b/src/content/docs/advanced/ai-powered-features/images/Refresh_Requirement_2.gif new file mode 100644 index 00000000..67b2fc35 Binary files /dev/null and b/src/content/docs/advanced/ai-powered-features/images/Refresh_Requirement_2.gif differ diff --git a/src/content/docs/advanced/ai-powered-features/images/Req_empty_project_1.png b/src/content/docs/advanced/ai-powered-features/images/Req_empty_project_1.png new file mode 100644 index 00000000..ec08a894 Binary files /dev/null and b/src/content/docs/advanced/ai-powered-features/images/Req_empty_project_1.png differ diff --git a/src/content/docs/advanced/ai-powered-features/images/Req_empty_project_2.png b/src/content/docs/advanced/ai-powered-features/images/Req_empty_project_2.png new file mode 100644 index 00000000..4735f5ef Binary files /dev/null and b/src/content/docs/advanced/ai-powered-features/images/Req_empty_project_2.png differ diff --git a/src/content/docs/advanced/ai-powered-features/images/Req_page_1.png b/src/content/docs/advanced/ai-powered-features/images/Req_page_1.png new file mode 100644 index 00000000..2f6b29c8 Binary files /dev/null and b/src/content/docs/advanced/ai-powered-features/images/Req_page_1.png differ diff --git a/src/content/docs/advanced/ai-powered-features/images/Requirement_page_details_1.gif b/src/content/docs/advanced/ai-powered-features/images/Requirement_page_details_1.gif new file mode 100644 index 00000000..009947c4 Binary files /dev/null and b/src/content/docs/advanced/ai-powered-features/images/Requirement_page_details_1.gif differ diff --git a/src/content/docs/advanced/ai-powered-features/images/Requirements_1.gif b/src/content/docs/advanced/ai-powered-features/images/Requirements_1.gif index 94f7f318..3e9a08cf 100644 Binary files a/src/content/docs/advanced/ai-powered-features/images/Requirements_1.gif and b/src/content/docs/advanced/ai-powered-features/images/Requirements_1.gif differ diff --git a/src/content/docs/advanced/ai-powered-features/images/Unlink_Requirement_1.png b/src/content/docs/advanced/ai-powered-features/images/Unlink_Requirement_1.png new file mode 100644 index 00000000..c808e3ff Binary files /dev/null and b/src/content/docs/advanced/ai-powered-features/images/Unlink_Requirement_1.png differ