Перейти к содержимому

Как читать эту базу знаний

Читаемое описание того, как продукт себя ведёт: услуги, роли, процессы, устройство платформы. Цель — чтобы новый человек понял систему, не читая 350 файлов требований.

  • Постановки задач. Story, критерии приёмки и трассировка живут в yooca-requirements и в репозиториях модулей.
  • Решений. Принятые архитектурные и процессные решения — decisions/ зонтичного репозитория.
  • Открытых вопросов и багов. Их реестры — тоже в зонтичном.

Вики — витрина поверх требований, а не источник истины. Если страница противоречит требованиям или коду, права сторона требований: заводится правка страницы, а не наоборот. Порядок приоритета при разборе такой же, как в FAQ-флоу: контракт API → требования и решения → спецификация → код.

Обычным MR в этот репозиторий: ветка от develop, ревью, мерж. Кнопка «Редактировать страницу» внизу каждой страницы ведёт прямо в нужный файл.