Как ты документируешь свой код и решения?

Junior
139 просмотров
AFK Offer AI

Код: понятные имена > комментарии, комментарии для "почему" а не "что". README: как запустить, архитектура, ключевые решения. ADR (Architecture Decision Records) для важных решений. API: OpenAPI/Swagger. Runbooks для операционных процедур. Не документировать всё подряд — только то что будет полезно через 6 месяцев. Документация как код — в репозитории, review через PR.

Следующий вопрос

Как использовать PostgreSQL как message broker?