Как я генерирую документацию с помощью ИИ: пошаговая инструкция 📝
За последние полгода я довел до автоматизма процесс создания документации с помощью ИИ. Делюсь рабочим алгоритмом (нет, это не про "просто попросить ChatGPT написать док").
🎯 Мой алгоритм работы 1️⃣ Определяем цель и аудиторию
- Кто будет читать документ?
- Что читатель должен понять?
- Какие вопросы у него возникнут? Это критически важно – ИИ подстроится под портрет читателя.
2️⃣ Составляем структуру
- Выписываем обязательные разделы, не паримся, если что-то забыли, ИИ потом предложит дополнительные разделы.
3️⃣ Собираем контекст
- Пишем всё, что знаем, в свободной форме
- Пример: "встречи по статусу проекта каждый Пн в 11:00"
- Чем больше деталей – тем лучше результат
- Не форматируем, просто выгружаем информацию
4️⃣ Генерируем с ИИ
- Скармливаем всё собранное
- Просим учесть портрет читателя
- Указываем желаемый стиль и формат
- Проверяем предложенную структуру
5️⃣ Правим и дополняем
- Вычитываем внимательно
- Правим руками или с помощью ИИ
- Добавляем упущенные детали
- Проверяем на соответствие цели
🔥 Важный момент: Вы должны ЗАРАНЕЕ понимать, что хотите увидеть в документации. ИИ – помощник в формулировках, а не замена вашей экспертизы.
💡 Полезный хак: Если вообще не знаете, с чего начать – попросите ИИ показать шаблон похожей документации. Например: "Покажи структуру шаблона проектного паспорта."
❌ Типичные ошибки:
- Просить ИИ "написать документацию" без контекста
- Не проверять сгенерированный текст
- Слепо копировать шаблоны
- Игнорировать специфику аудитории
Ссылка на шаблон и пример промпта https://docs.google.com/document/d/13jZseS4rsij3uWpVaRfT4yrPyU9nHy4kAiJOtuAF9pI/edit?hl=ru&tab=t.0
А как вы работаете с документацией? Делитесь в комментах 👇