Skip to content
Merged
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
8 changes: 8 additions & 0 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -328,6 +328,13 @@ export default defineConfig({
{ label: 'Living Documentation', link: '/advanced/living-doc' }
],
},
{
label: 'Mermaid Diagrams',
collapsed: true,
items: [
{ label: 'Mermaid Diagrams for Test Design', link: '/advanced/mermaid-diagrams' }
],
},

{
label: 'Jira Plugin',
Expand All @@ -349,6 +356,7 @@ export default defineConfig({
{ label: 'AI-Powered Features', link: '/advanced/ai-powered-features/ai-powered-features' },
{ label: 'AI-Requirements', link: '/advanced/ai-powered-features/ai-requirements' },
{ label: 'AI-Agents', link: '/advanced/ai-powered-features/ai-agents' },
{ label: 'Voice Mode', link: '/advanced/ai-powered-features/voice-mode' },
],
},
{
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
68 changes: 68 additions & 0 deletions src/content/docs/advanced/ai-powered-features/voice-mode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
title: Voice Mode
description: Dictate test steps, requirements, comments, and TQL filters in Testomat.io instead of typing them. This guide covers turning Voice Mode on, recording your text, and what AI does with the transcription.
type: article
url: https://docs.testomat.io/advanced/ai-powered-features/voice-mode
head:
- tag: meta
attrs:
name: keywords
content: Voice Mode, voice input, dictate test steps, speech to text, transcription, AI formatting, test descriptions, requirements, TQL, accessibility, Testomat.io
---

Voice Mode lets you dictate text instead of typing it. Speak your test steps, requirements, or exploratory testing notes, and Testomat.io writes them into the editor for you. Dictating saves time on long test steps and gives an option to people who find typing hard.

## Turn Voice Mode On

Voice Mode is part of the AI-powered features, so it follows the same setting.

1. Open your project settings.
2. Enable **AI features**.

## Dictate the Text

1. Open the field you want to fill in.
2. Click the **Dictate** icon.
3. Speak your text.
4. Click **Stop** when you finish.

![The New Requirement form with the Stop button active while recording](./images/voice-mode-requirement.png)

The button turns red while it records, and the bars on it move when Testomat.io hears you. AI improves the grammar, punctuation, and formatting as it goes, and once more after you stop.

Voice Mode works in test and suite descriptions, requirements, comments, TQL filters, and the Chat with Tests input.
If the microphone icon is missing, your company or project has AI turned off. See the
[Administration section](https://docs.testomat.io/management/company/administration/#ai) to enable it.

:::note

The editor is briefly read-only while AI formats the text. If formatting is unavailable, the raw transcription stays.

:::

## Recording Rules

| Rule | What it means |
| -------- | ------------- |
| Text is in short bursts | Audio is sent for transcription in segments, so text appears during the recording. |
| English by default | Dictation uses English unless your project sets other language. |
| Closing the editor stops the recording | Navigating away ends the session without saving — click **Stop** to keep the text. |

If this doesn't work:

- **No microphone icon**, or a message asking you to enable AI features — AI is
off for the project.
- **Microphone access denied** — allow microphone access for `app.testomat.io`
in your browser settings, then click **Dictate** again.
- **No sound recognized. Please try again.** — nothing audible was captured.
Check that the right input device is selected in your system settings.
- **Transcription failed** or **Transcription timed out** — the request did not
reach the service. Record a shorter passage and try again.
- The text is unformatted — AI formatting was unavailable at that moment.
The transcription is still yours to edit.

## Next Steps

- [AI-Powered Features](./ai-powered-features.md)
- [AI-Requirements](./ai-requirements.md)
- [TQL](https://docs.testomat.io/advanced/tql)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
52 changes: 52 additions & 0 deletions src/content/docs/advanced/mermaid-diagrams/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
title: Mermaid Diagrams for Test Design
description: Add Mermaid diagrams to test and suite descriptions in Testomat.io to model workflows, decision branches, state transitions, and dependencies before testing begins.
type: article
url: https://docs.testomat.io/advanced/mermaid-diagrams
head:
- tag: meta
attrs:
name: keywords
content: Mermaid diagrams, test design, flowchart, state diagram, E2E journey, coverage map, defect reproduction, suite description, markdown editor, Testomat.io
---

Write the diagram as a code block, and Testomat.io shows it as a picture. Add a Mermaid diagram to any test or suite description. Diagrams are most useful for big features with many states. Use a diagram to show a workflow, the branches of a scenario, or how parts of your product connect.

## Add a Diagram to a Description

1. Open the test or suite you want to document.
2. Click **Edit**.
3. Switch to the **Markdown** tab.
4. Add a fenced code block that starts with ` ```mermaid `.
5. Write the diagram inside the block.
6. Click **Save**.

![The Markdown tab of the test editor with a Mermaid flowchart block](./images/1-mermaid-markdown.png)

The **Preview** tab shows the diagram before you save. After you save, the picture appears in the description instead of the code block. For example, flowchart can look like this:

![A checkout flow drawn as a diagram, branching into payment confirmed and payment declined](./images/2-mermaid-preview.png)

## Download a Diagram

Each diagram has **SVG** and **PNG** buttons. Click one to download the picture and use it in a slide, a ticket, or a report outside Testomat.io.

**Use a diagram when you need to show how things connect:**

- end-to-end user journeys,
- how services work with each other,
- which suites cover which features,
- test data and its variants,
- the steps that reproduce a bug.

:::note

Testomat.io can build a mindmap for you. **Generate Project Structure** reads your folders and suites and suggests a new structure as a diagram. Learn more: [AI-Powered Features](https://docs.testomat.io/advanced/ai-powered-features/ai-powered-features).

:::

## Next Steps

- [AI-Powered Features](https://docs.testomat.io/advanced/ai-powered-features/ai-powered-features)
- [Living Documentation](https://docs.testomat.io/advanced/living-doc)
- [Test Case Creation and Editing](https://docs.testomat.io/project/tests/test-case-creation-and-editing)
Loading