Архитектурная документация проекта в нарративном стиле. Каждый документ объясняет не только «что», но и «почему» — мотивация решений, компромиссы, модели угроз.
Документы выстроены от общего к частному — как zoom камеры: сначала система целиком, потом внутренности, потом детали.
| # | Документ | Уровень | О чём |
|---|---|---|---|
| 1 | C4 Context | Система | Кто взаимодействует с PKI-on-Box и зачем. 4 актора, 3 границы доверия |
| 2 | C4 Container | Внутренности | Что внутри: 5 слоёв, 16 компонентов, путь запроса через 11 шагов |
| 3 | Component Overview | Анатомия | Каждый компонент: зачем существует, как работает, почему именно так |
| 4 | Class Diagram | Классы | 14 классов, 5 слоёв, цепочка доверия от теплового шума к сертификату |
| 5 | Sequence Flows | Время | 5 историй: startup, ceremony, issuance, revocation, entropy chain |
| 6 | Deployment Diagram | Железо | 3 мира (Workstation, STM32, RK3328), USB как слабое звено, $129 |
| 7 | Deployment Guide | Практика | 10 шагов от голого железа до первого сертификата |
- «Что это за система?» → начни с C4 Context
- «Как устроена внутри?» → C4 Container → Component Overview
- «Хочу развернуть» → сразу в Deployment Guide
- «Как работает криптография?» → Sequence Flows, раздел Entropy Chain
- «Какие классы, какие зависимости?» → Class Diagram