ИИ-ассистент: техническая документация
README, руководства по установке, API-справки, примеры использования, changelog и документация процессов.
О чём Док-Бот спросит, прежде чем отвечать
Уточняющий вопрос здесь не вежливость, а правило роли: без ответа на него разговор пошёл бы про среднее, а не про ваше. Значит, первое сообщение можно написать сразу с ответами — аудиторию, цель, формат, версию продукта. Тогда второй ответ будет уже про задачу, а не ещё одним кругом уточнений.
✓ «Перед созданием документации уточняй аудиторию, цель, формат, версию продукта, окружение и предоставленные источники истины: код, схемы, команды, конфигурацию и фактическое поведение.»
Как Док-Бот ведёт работу над текстом
В правилах роль названа так: «технический писатель». Ниже — как она держит работу над текстом, теми же словами, что заданы ей до вашего первого сообщения. Манера и есть то, чем один собеседник отличается от другого, а показать её честно можно только цитатой.
«Сохраняй единые термины и давай копируемые примеры без секретов.»
Чего Док-Бот делать не станет
В правилах роли 7 правил, и 2 запрета среди них — прямые. Мы приводим их дословно, а не пересказом: обещать «умеет всё» дешевле, но тогда человек упирается в границу уже после отправленного сообщения. Здесь она видна заранее — и, если задача попадает в запрет, соседнюю роль лучше выбрать сразу.
«Не заявляй, что прочитал репозиторий или файл, если содержимое не передано через поддерживаемый интерфейс.»
«Не выдумывай команды, параметры API, ответы, переменные окружения, совместимость, версии и результаты запуска.»
Что Док-Бот даёт в ответе
Форму ответа задают правила роли, а не настроение разговора: одно и то же, спрошенное дважды, придёт в одном и том же виде. Это и есть разница между ролью и чистым листом — на чистом листе форму приходится описывать каждый раз заново.
«Структурируй README как назначение, быстрый старт, требования, установка, настройка, использование, примеры, тесты, типичные ошибки и поддержка — включая только применимые разделы.»
Три вопроса, которые Док-Бот предлагает первыми
Нажатие открывает чат с уже набранным сообщением. Это не наши примеры «что тут можно спросить», а предложение самой роли: те же три строки стоят в пустом окне разговора.
Сколько стоит сообщение роли «Техническая документация»
Счёт идёт за отправленное сообщение, а не за месяц доступа: роль, которая нужна раз в квартал, между разами не стоит ничего, и отдельную строку расходов под неё заводить не приходится.
3 кредита за сообщение
Цена одинакова для короткого и длинного сообщения — считается отправка, а не количество написанного.
Без абонентской платы
Десять сообщений в месяц и стоят как десять сообщений: расход считается по факту, а не по тарифу.
Что Док-Бот пометит как требующее проверки
Опасно не незнание, а уверенный тон поверх догадки: по такому ответу принимают решение, и цена ошибки достаётся человеку, а не программе. Поэтому в правилах роли отдельно записано, что помечать, о чём предупреждать и где просить источник.
«Отделяй подтверждённое от мест для заполнения и помечай неизвестное как TODO с конкретным вопросом.»
«Для API указывай метод, путь, авторизацию, параметры, примеры запроса и ответа, ошибки и ограничения только по подтверждённым данным.»
Частые вопросы об этом ассистенте
Короткие ответы
Чем Док-Бот отличается от обычного чата
В обычном чате постановка задачи ложится на вас: и порядок вопросов, и рамки, и требования к ответу — заново в каждом новом окне. Здесь это уже написано: 7 правил, из них 2 запрета, и все они приведены на этой странице целиком. Повторять их в переписке не нужно — экономится как раз то время, ради которого чат и открывают.
✓ Правил роли: 7, из них запретов: 2
✓ Полка каталога: Тексты и редактура
✓ Отвечает программа, а не человек: врача, юриста и психолога она не заменяет
Док-Бот и соседи по полке «Тексты и редактура»
На этой полке каталога 8 ролей: задачи у них соседние, а правила разные — и у каждой они показаны так же, целиком.
Лев
Редактор
Ника
Помощник исследователя
Корректор текста
Орфография и пунктуация
Аналитик текстов
Факты, тезисы и структура
Короткие ответы
Кратко и по существу
Контент-алхимик
Один материал — несколько форматов
Переводчик
Перевод, который звучит как оригинал
Тарифы GeneroniumКредиты работают на всех сервисах
Лайт
Подписка на 30 дней
- Начисление при оплате и каждые 30 дней
- Автопродление отключается в личном кабинете
- Кредиты тратятся на любой сервис Generonium
- Точная цена сервиса видна до запуска
Про
Подписка на 30 дней
- Начисление при оплате и каждые 30 дней
- Автопродление отключается в личном кабинете
- Кредиты тратятся на любой сервис Generonium
- Точная цена сервиса видна до запуска
Макс
Подписка на 30 дней
- Начисление при оплате и каждые 30 дней
- Автопродление отключается в личном кабинете
- Кредиты тратятся на любой сервис Generonium
- Точная цена сервиса видна до запуска