---
title: "BETS Tutorial Documentation Guidelines"
canonical_url: "https://apidocs.sportradar.com/resources/widgets/docs/tutorials/guidelines-tutorial"
markdown_url: "https://apidocs.sportradar.com/resources/widgets/docs/tutorials/guidelines-tutorial.md"
last_updated: "2026-01-13T14:50:54Z"
---

# BETS Tutorial Documentation Guidelines

> **Info**
>
> This is guidelines document for **tutorials** documentation. If you are looking for guidelines for writing product documentation, see [Product Documentation Guidelines](https://apidocs.sportradar.com/resources/widgets/docs/tutorials/guidelines_product.md).

## Coarse Guidelines

Tutorials must be structured as clear step-by-step guides. Each tutorial must include:

- **Title**
  *Short, descriptive, and informative.*

- **Intended Audience**
  *Who the tutorial is for, including relevant roles, skill levels, and product familiarity.*

- **Goals**
  *A clear statement of what the user will achieve or learn by completing the tutorial.*

- **Environment Specification (Prerequisites)**
  *All required software, tools, libraries, APIs, versions, accounts, and permissions. Network or storage requirements should also be noted.*

- **Sequence of Steps**
  *A clear and linear set of instructions. Each step should explicitly state what must be done, without assuming prior knowledge. Branching paths must be clearly indicated.*

- **Further Reading**
  *Links to related documentation, tutorials, or external references that extend the tutorial or cover adjacent use cases.*

## Details Per Section

### Title

- Short, direct, and descriptive.
- Should give users a clear sense of what the tutorial covers.

**View example**

**How not to do it**

**No title case, no description**

```markdown
---
title: "Widgets theming"
---
```

### Intended Audience

- Specify relevant roles (developer, integrator, product manager).
- Indicate required background knowledge.
- Clarify product/feature scope and depth of coverage.

**View example**

### Goals

- Clearly describe the outcomes and skills gained.
- State what the user will know or be able to do after completing the tutorial.

**View example**

**How not to do it**

**Too vague**

## Goals

In this tutorial you will learn how to theme your widgets.

### Environment Specification (Prerequisites)

- List all required setup components:
  - Software, libraries, APIs.
  - Versions (when relevant).
  - Required accounts and permissions.
  - Network/storage requirements.
- Provide links to instructions for obtaining or setting up prerequisites.

**View example**

**How not to do it**

**Too detailed, frivolous, contains prerequisites of prerequisites**

## Prerequisites

In order to complete this tutorial you will need:

| Browser     | Version | Mobile Support       |
| ----------- | ------- | -------------------- |
| **Chrome**  | 60+     | ✅ Chrome Mobile 60+  |
| **Firefox** | 55+     | ✅ Firefox Mobile 55+ |
| **Safari**  | 12+     | ✅ iOS Safari 12+     |
| **Edge**    | 79+     | ✅ Edge Mobile 79+    |

- JavaScript enabled
- XMLHttpRequest support for data fetching
- CSS3 support for styling and animations
- a laptop
  - a mouse
  - a screen
- a website with an integrated Sportradar widget.
  - React framework V19.1 or newer
  - if you need to integrate your widget first, see the [getting started guide](https://apidocs.sportradar.online/resources/widgets/docs/README.md)
- access to Sportradar [widgets demo page](https://widgets.sir.sportradar.com/widgets-demo)
- a text editor of your choice

### Tutorial Steps

- Present steps in a sequence.
- Avoid **common knowledge** assumptions, explain each step.
- Each step must explicitly build on the previous one.
- Where the tutorial forks:
  - Clearly indicate branching options.
  - Provide navigation instructions (e.g., "If following option A, continue here. For option B, jump to section X") **with links to all branches**.

### Further Reading

- Suggest additional documentation, related tutorials, or reference material.
- Include links to external standards or tools if relevant.
- Can be omitted if no relevant external resources are available.

**View example**
