Files
specs/openspec/changes/archive/2026-08-12-baseline/specs/project-documentation/spec.md
T
2026-08-12 23:09:16 +03:00

2.6 KiB

Purpose

Определяет обязательную документацию архитектурных решений и пользовательских возможностей, сопровождающую SDD-изменения WealthLedger.

ADDED Requirements

Requirement: Важные архитектурные решения фиксируются в ADR

Репозиторий docs SHALL содержать ADR для выбора локального хранилища, API-контракта, gRPC-интеграции T-Bank, хранения T-Bank токенов, устойчивости upstream-вызовов, auth-сессий и frontend-кэша. Каждый ADR MUST описывать контекст, решение и последствия.

Scenario: Разработчик оценивает архитектурное ограничение

  • WHEN разработчик хочет изменить один из зафиксированных механизмов
  • THEN он может определить исходное решение и его последствия из соответствующего ADR

Requirement: Реализованная фича получает документацию

Каждая завершенная пользовательская фича SHALL иметь Markdown-документ в docs/features, описывающий пользовательский поток, API-сценарий, ограничения и необходимые Mermaid-диаграммы.

Scenario: Функциональное изменение готово к закрытию

  • WHEN реализация пользовательской фичи завершена
  • THEN ее feature-документ существует и отражает фактическое поведение

Requirement: OpenSpec change закрывается только после полной верификации

Функциональный OpenSpec change MUST содержать все требуемые артефакты, реализацию, критические тесты, успешную проверку opsx-verify и связанную документацию до архивирования.

Scenario: Команда пытается архивировать незавершенное изменение

  • WHEN для изменения отсутствует реализация, верификация или feature-документ
  • THEN изменение не считается готовым к архивированию