Planet Python на русском
Подписаться
Go Deh: Поиск ошибок в технической документации
Автор разработал новый подход к тестированию документации с использованием ИИ. После обновления учебных пособий и документации проекта в файлах Markdown, он решил использовать ИИ для проверки их эффективности. Автор дал ChatGPT указание создать изолированную среду чата, где он будет читать документацию и пытаться использовать описанный инструмент. ИИ согласился, сгенерировав подробный запрос для нового чата и отслеживая его прогресс.Затем ИИ сообщил о выявленных недостатках в документации. Например, он отметил, что в документации отсутствует явное указание на предполагаемое использование инструмента в Linux, несмотря на предоставление деталей настройки для Linux и WSL. Это побудило ИИ попытаться запустить инструмент в среде Windows, выявив неявное предположение автора, которое требовало уточнения.Автор ценит этот метод, при котором ИИ выступает в роли нового пользователя, активно пытаясь выполнить задачи и сообщая о возникших проблемах. Это выходит за рамки простой проверки формулировок, обеспечивая практическую проверку выполнимости инструкций в документации. Хотя ИИ может выдвигать необоснованные замечания, человеческое суждение остается решающим при определении того, какие изменения следует внедрять.Автор подчеркивает, что документация должна служить как людям, так и ИИ-помощникам. Поскольку все больше пользователей, вероятно, будут использовать ИИ для взаимодействия с проектом, документация должна быть достаточно понятной для прямого использования человеком и для того, чтобы ИИ мог эффективно помогать пользователям. Это означает, что необходимо учитывать, насколько хорошо документация поддерживает взаимодействие с ИИ, а не только писать исключительно для ИИ.В конечном итоге, автор предлагает тестировать документацию аналогично коду, оценивая, сможет ли пользователь, человек или ИИ, успешно следовать ей для выполнения задачи. Этот инновационный метод тестирования предлагает новый взгляд на повышение эффективности документации в будущих проектах.