Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Rules (anti‑redundant)

  • Цель первой строкой. Нет цели — нет файла.
  • Один файл — одна тема. >600 строк или >3 крупные темы → дроби.
  • Папка сервиса (escrow/wallet/bridge) имеет свой README.md; внутри — flows/, decisions/ (ADR), problems/, diagrams/. Общие/сквозные флоу — в корневом flows/.
  • Не дублируй определения: всё в glossary.md (когда появится) или ссылайся на первоисточник.
  • Решения фиксируй как мини‑ADR (Context/Decision/Consequences), не переписывай длинными абзацами.
  • Ссылки вместо копипаста: код, RFC/ADR, регуляторные PDF.
  • Диаграммы только в текстовых форматах (Mermaid/PlantUML) рядом с MD; картинки без исходников запрещены.
  • Статус в шапке: draft/accepted/deprecated/superseded; помечай владельца.
  • В конце каждого файла — блок Next (до 5 пунктов) или чек‑лист; пустым не оставлять.
  • Убирай воду: факты, решения, риски, next steps. Истории и рассуждения — в main/ или в отдельный черновик.
  • Обновил код/арх/процесс → оставь ссылку в релевантном файле (не копируй текст).

ADR / flows (минимальный набор)

  1. Именуй decision с датой: decision-YYYY-MM-DD-topic-name.md (облегчает хронологию).
  2. Flow и код идут одним PR; документация лежит в src/.../flows или src/.../decisions (mdbook).
  3. Каждое решение = одна страница по шаблону (adr/adr-template.md).
  4. Статусы: draft → proposed → accepted → deprecated → superseded; фиксируй переход.
  5. В релизной ноте пиши, какие решения стали accepted (живыми) в релизе.