Какую документацию приходилось писать
Python
Senior
Без компании
Какую документацию приходилось писать
Ответы
Приходилось писать несколько типов документации:
- **Docstrings** (PEP 257) для модулей, классов и функций. Например:
```
def calculate_sum(a: int, b: int) -> int:
"""Складывает два числа и возвращает результат.
Args:
a: Первое слагаемое
b: Второе слагаемое
Returns:
Сумма a и b
Raises:
TypeError: Если аргументы не являются числами
"""
return a + b
```
- **README.md** для проектов с описанием установки, использования и примеров
- **API документацию** (Swagger/OpenAPI) для REST сервисов
- **Технические спецификации** для сложных фич с описанием архитектуры
- **Руководства пользователя** для внутренних инструментов
Всегда стараюсь делать документацию:
- Достаточной, но не избыточной
- С примерами использования
- Актуальной (синхронизирую с кодом)
- Доступной для целевой аудитории