Ответ
Баг документации — это дефект, при котором документация (техническая, пользовательская, API-спецификация) не соответствует фактическому поведению системы.
Примеры:
- Устаревшая информация: В руководстве указана старая кнопка "Сохранить", которая была переименована в "Экспорт".
- Некорректная спецификация API: Документация утверждает, что эндпоинт
GET /api/usersвозвращает полеemail, но в реальности оно называетсяuserEmail. - Неполное описание: В документации к функции не указан обязательный параметр
timeout.
// Пример бага документации для API
// Документация говорит:
// GET /products → {"id": number, "price": number}
// Реальность:
// GET /products → {"productId": string, "cost": number, "currency": string}
Почему это важно: Такие баги вводят в заблуждение разработчиков, тестировщиков и конечных пользователей, увеличивая время на интеграцию и поддержку.