> For the complete documentation index, see [llms.txt](https://docs.autommate.com/userguide/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.autommate.com/userguide/start-here/documentation-conventions.md).

# Documentation conventions

Find the right guide, follow examples and check execution and service results.

Use these conventions to navigate Autom Mate documentation, follow a task and interpret the result. The same names and checkpoints apply when a person follows a guide or an AI agent reads a tool reference.

### Choose the right page

**Task guides** take you from prerequisites through configuration to a result you can check. Follow numbered steps in order and review the verification section before moving to the next task.

**Concept pages** explain how components relate. **References** define fields, parameters and valid values. **Troubleshooting pages** start with a symptom and help you choose the next check. Follow related links when you need a contract or explanation rather than repeating a procedure.

### Check applicability

Check the edition and version stated on the page. Use written steps with the screenshots; available controls can differ by role or edition.

A worked example describes the recorded configuration and result. An **illustrative example** shows a pattern to adapt. Replace example identifiers with values from your own environment, and confirm the applicable input contract before running anything.

### Separate execution from the outcome

Treat these as different checkpoints:

| Checkpoint            | What it establishes                                  |
| --------------------- | ---------------------------------------------------- |
| Saved or configured   | The configuration exists.                            |
| Released or published | A version is available for its intended use.         |
| Deployed              | The service has a target configuration.              |
| Started or completed  | Execution has begun or reached a recorded end state. |
| Verified outcome      | Evidence confirms the intended result.               |

Check the returned output or destination record as well as execution status. For service delivery, review both the Case Status and Result.

### Read labels and identifiers literally

**Bold text** names controls such as **New deployment**. `Code text` preserves tool names, parameters, identifiers and literal values. Keep their spelling, casing and types unchanged.

Service Case Status and Result describe service outcomes; MCP run states describe tool execution. Use the values documented for the interface you are working with.

### Use visuals and examples accessibly

Screenshots have descriptive alternative text; captions explain the relevant control or context. Diagrams complement the written explanation. Essential steps and result criteria remain available as text, so you do not need to interpret an image alone.

Link labels describe their destination. Code examples should remain selectable and searchable. Keep credentials, tokens and customer information out of copied examples and support screenshots.