Добавил документацию и описание репозитория

2026-06-13 17:10:53 +03:00
parent 82a81c16af
commit 5b53f4e8e8
12 changed files with 647 additions and 0 deletions
@@ -0,0 +1,17 @@
+# Документация jellybit
+
+Три раздела с разной ролью — не путать:
+
+- **[specs/](specs/)** — спецификации. Описывают **целевое и текущее**
+  устройство системы. Живые и изменяемые: правим по мере развития,
+  держим в соответствии с кодом. Отвечают на вопрос «как устроено».
+
+- **[adr/](adr/)** — Architecture Decision Records. **Неизменяемый**
+  журнал значимых решений, пишется **постфактум**. Хранит главное —
+  *почему* так сделано. Передумали → не правим старую запись, заводим
+  новую. Процесс — в [adr/README.md](adr/README.md).
+
+- **[drafts/](drafts/)** — черновики: заметки, мысли, планы на будущее,
+  ещё не принятые решения. Не источник истины и ни к чему не обязывают.
+  Когда черновик становится реальностью — его место в specs (как
+  устроено) и/или adr (почему решили).