Как вы относитесь к написанию технической документации?

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

• Повышает сопровождаемость кода: помогает новым членам команды и будущим разработчикам понять систему.
• Сокращает время на онбординг: четкие README, описания API и архитектурные решения экономят время всей команды.
• Фиксирует контекст и решения: документирование ключевых архитектурных решений (например, с помощью ADR — Architecture Decision Records) объясняет, почему был выбран тот или иной подход.

На практике я следую принципу "код как документация" (используя чистые имена и структуру), но всегда дополняю это:

1. README.md для проекта с инструкциями по запуску.
2. Комментарии в коде для сложной бизнес-логики (объясняющие "почему", а не "что").
3. Документация к публичным API (например, с использованием Swagger/OpenAPI).

Пример структуры README:

# Project X

## Overview
Краткое описание сервиса и его цели.

## Quick Start
```bash
git clone ...
docker-compose up

API Endpoints