Шаблон обзорного документа

Язык

Документация пишется на русском. Английский — только для технических терминов, API, сущностей, полей, событий, библиотек, кода.

Использовать для:

• ecosystem/*.md;
• domains/name/overview.md;
• platform/overview.md;
• migration/overview.md.

Не использовать для детальной функции — для неё есть specification.md.

Frontmatter

---
title: <русский заголовок>
sidebar_label: <короткий>
sidebar_position: <число>
status: active | draft | deprecated
version: v<major>.<minor>
updated: 2026-04-30
owners:
  - <команда>
canonical: true | false
---

Структура

# Название

## Зачем нужно

Коротко: какую проблему решает область и зачем существует.

## Что входит

- ...

## Что не входит

- ...

## Чем владеет

Какие сущности, правила или процессы — источник истины именно здесь.

## Главные правила

- ...

## Карта документов

| Документ | Что описывает |
|---|---|
| `file.md` | ... |

## Связи с экосистемой

С какими доменами или слоями связан, что получает/отдаёт.

Правила

• Не писать общие фразы без последствий для реализации.
• Не дублировать подробности из дочерних документов.
• Пустые разделы убирать.
• Overview помогает понять границы, а не заменяет спецификацию.
• Любая ссылка на конкретный документ — относительный путь, существующий в target/.