📚 Пять документов, на которых держится проект
Один файл с описанием проекта работает, пока проект маленький. Дальше он превращается в свалку, где ничего не найти, и его перестают читать — и человек, и нейросеть.
Поэтому документы разделены по назначению. У каждого своя работа:
📕 Законы. Что нельзя делать никогда. При какой ситуации остановиться и спросить человека. В каком порядке принимаются решения. Читается перед любой существенной правкой, без исключений.
📗 Состояние. Что где работает прямо сейчас: какие службы, на каких машинах, в каком порядке всё выкатывается. Файл, разошедшийся с реальностью, хуже отсутствующего — по нему принимают решения.
📘 Журнал изменений. Каждая выкатка на боевой: дата, что поменялось и почему. Сейчас там больше сотни записей, и это самый читаемый файл в проекте.
📙 Правила предметной области. Отдельно по каждому крупному куску: как считается склад, что делать при исправлении уже проведённого документа.
📓 Планы этапов и отчёты о проверках. По файлу на этап: что собирались сделать, что проверили, что решили не трогать.
Чтобы документы не спорили между собой, задана иерархия важности:
> решение человека → записанные правила → как система ведёт себя на боевом → устройство кода → мнение нейросети
Нижнее не отменяет верхнее молча. Если они противоречат друг другу — работа останавливается, и противоречие выносится мне.
Это, пожалуй, самое полезное правило из всех. Именно в таких местах раньше и возникали неприятные сюрпризы.
