Документация Markdown с Mermaid
Документация Markdown с Mermaid: практическое руководство с демо, чеклистом проверки и заметками по публикации для Markdown со встроенным Mermaid.

Какую задачу это решает
Документация Markdown с Mermaid полезен, когда диаграмма является не просто картинкой, а поддерживаемой частью документации. Исходник должен оставаться читаемым, предпросмотр должен показывать ошибки, а экспорт должен работать в README, wiki или блоге.
Используйте этот подход для README, API-заметки, RFC и статьи справки. Цель — короткий цикл редактирования, предпросмотра и проверки перед публикацией.

Небольшое демо для вставки
Не начинайте с полного production-содержимого. Сначала используйте небольшой фрагмент, чтобы проверить синтаксис, подписи и раскладку.
Когда первый предпросмотр сработает, добавьте реальные имена сервисов, поля, акторов или зависимости.
# Checkout flow
The API creates an order, then asks the payment service to confirm it.
```mermaid
sequenceDiagram
participant User
participant Store
participant Payment
User->>Store: POST /orders
Store->>Payment: Create payment intent
Payment-->>Store: Confirmed
Store-->>User: Order receipt
```Как проверять предпросмотр
Проверяйте как коллега, который читает страницу. Отвечает ли она на один понятный вопрос? Можно ли безопасно изменить исходник позже?
Для AI-контента проверяйте имена, направление, группировку и пропущенные связи.
Частые ошибки
Частая ошибка — пытаться объяснить всё одной диаграммой. Разделяйте request flow, данные, инфраструктуру и publishing output.
Другая ошибка — экспортировать только картинку. Храните исходный текст вместе с SVG или PNG.
Чеклист перед публикацией
Перед публикацией проверьте чёткость, длинные подписи и наличие воспроизводимого примера.
Страница выглядит сильнее, когда показывает вход, предпросмотр и решение после проверки.