Какую документацию приходилось писать

Приходилось писать несколько типов документации:

1. Docstrings (PEP 257) для модулей, классов и функций. Например:

def calculate_sum(a: int, b: int) -> int:
    """Складывает два числа и возвращает результат.
    
    Args:
        a: Первое слагаемое
        b: Второе слагаемое
        
    Returns:
        Сумма a и b
        
    Raises:
        TypeError: Если аргументы не являются числами
    """
    return a + b

2. README.md для проектов с описанием установки, использования и примеров

3. API документацию (Swagger/OpenAPI) для REST сервисов

4. Технические спецификации для сложных фич с описанием архитектуры

5. Руководства пользователя для внутренних инструментов

Всегда стараюсь делать документацию:

• Достаточной, но не избыточной
• С примерами использования
• Актуальной (синхронизирую с кодом)
• Доступной для целевой аудитории