Как вы обычно пишете документацию по разработке и коду?

Документируйте контракты, причины решений и действия, которые трудно восстановить из кода. Документация должна иметь аудиторию, владельца и обновляться вместе с изменением поведения.

Для API полезны входы, выходы, ошибки и примеры; для архитектуры — границы компонентов и принятые компромиссы; для эксплуатации — запуск, диагностика и восстановление. Комментарии в коде объясняют «почему», а не пересказывают очевидную строку.

Расскажите, где храните документы и как проверяете их актуальность в review. Для нетривиальных решений подходит короткая запись контекста, вариантов и последствий. Не создавайте несколько противоречащих источников истины и не помещайте секреты в примеры команд.