💡 Примеры запросов
Документировать REST API
Напиши документацию для эндпоинта POST /api/v1/orders. Опиши: назначение, заголовки (Authorization), тело запроса (JSON), возможные статус-коды (201, 400, 401), пример успешного ответа. Стиль — для разработчиков.
🚀 Попробовать
Quick Start гайд
Напиши Quick Start руководство для нового пользователя CRM-системы. 5 шагов: регистрация, настройка профиля, создание первой сделки, добавление контакта, просмотр отчёта. С скриншотами (опиши словами что должно быть на каждом).
🚀 Попробовать
Спецификация в OpenAPI
Напиши спецификацию OpenAPI 3.0 для API интернет-магазина. Эндпоинты: GET /products (список с пагинацией), GET /products/{id}, POST /cart, POST /orders. Включи схемы данных и примеры ответов.
🚀 Попробовать
Release Notes
Составь Release Notes для версии 3.2 мобильного приложения. Включи: новые функции (тёмная тема, поиск по голосу), исправленные баги (краш при открытии PDF, проблемы с Touch ID), известные проблемы. Формат — для App Store и Google Play.
🚀 Попробовать
Документация SDK
Напиши документацию для JavaScript SDK библиотеки оплаты. Включи: установка (npm/yarn), инициализация (API key), методы (createPayment, checkStatus, refund), примеры кода для каждого метода, обработка ошибок.
🚀 Попробовать
❓ Частые вопросы
Какие форматы документации знает ИИ?
Markdown, reStructuredText, AsciiDoc, OpenAPI/Swagger, DITA, DocBook.
Может ли ИИ заменить техписателя?
ИИ генерирует черновики. Понимание продукта и потребностей пользователей — зона ответственности техписателя.
Экономит ли ИИ время?
Техписатели экономят до 50% времени на черновиках и обновлении документации.
OpaGPT