Использование Copilot: кейсы и примеры промптов
Copilot — ИИ-помощник, который работает в редакторе кода и понимает задачи, описанные обычным языком. Он как коллега, который берёт на себя рутину, но результат почти всегда требует вашей проверки. Для техписателя это особенно удобно, когда документация лежит в git (системе контроля версий) рядом с кодом — помощник видит файлы проекта и может их создавать, проверять и редактировать.
Задачу для Copilot называют промптом. Хороший промпт короткий, но самодостаточный: в нём есть контекст и ожидаемый результат. Разберём четыре кейса — промпты можно копировать и подставлять свои файлы.
📝 Кейс 1. Завести файл со стилем документации.
Сначала опишите правила стиля в отдельном файле — тогда Copilot будет придерживаться их в каждой задаче, а не угадывать стиль заново. Промпт:
Создай файл doc-style.md — правила стиля нашей документации: обращение на «вы», простые слова без канцелярита, первое упоминание термина сразу поясняем. Оформи чек-листом.
Внутри может получиться, например, такой чек-лист:
- Обращаемся к читателю на «вы».
- Пишем «используйте» вместо «осуществляйте».
- Новый термин объясняем при первом упоминании.
📝 Кейс 2. Проверить существующую документацию.
Канцелярит — это бюрократический язык: «осуществлять», «в рамках». Искать такие обороты и длинные абзацы вручную утомительно, поэтому поручите поиск Copilot, а решение об исправлениях оставьте себе. Промпт:
Проверь install.md по правилам из doc-style.md: найди канцелярит, длинные абзацы и непояснённые термины. Покажи проблемы списком с цитатами.
📝 Кейс 3. Написать новую документацию.
Черновые заметки есть у каждого техписателя, но собирать из них ровный текст — долгая работа. Copilot напишет раздел в вашем стиле, а вы отредактируете результат как текст коллеги. Промпт:
Напиши раздел «Установка» для инструкции новичка: шаги нумерованным списком, один шаг — одно действие, стиль по doc-style.md. Вот мои черновые заметки: …
📝 Кейс 4. Собрать changelog из истории изменений.
Changelog — список изменений продукта для пользователей. История уже хранится в git — по одному коммиту на каждую порцию правок, — и Copilot может переписать её человеческим языком. Промпт:
Посмотри последние 10 коммитов и собери черновик changelog для пользователей: что нового, что изменилось, что исправлено. Без технического жаргона.
🌼 Упражнение
Выберите кейс, который ближе к вашей работе, и попробуйте его на своём проекте.
1. Скопируйте промпт и подставьте название своего файла.
2. Отправьте промпт Copilot.
3. Прочитайте результат и внесите свои правки.
Получилось? Если нет, то задавайте вопросы в комментариях. 💖
Copilot — ИИ-помощник, который работает в редакторе кода и понимает задачи, описанные обычным языком. Он как коллега, который берёт на себя рутину, но результат почти всегда требует вашей проверки. Для техписателя это особенно удобно, когда документация лежит в git (системе контроля версий) рядом с кодом — помощник видит файлы проекта и может их создавать, проверять и редактировать.
Задачу для Copilot называют промптом. Хороший промпт короткий, но самодостаточный: в нём есть контекст и ожидаемый результат. Разберём четыре кейса — промпты можно копировать и подставлять свои файлы.
📝 Кейс 1. Завести файл со стилем документации.
Сначала опишите правила стиля в отдельном файле — тогда Copilot будет придерживаться их в каждой задаче, а не угадывать стиль заново. Промпт:
Создай файл doc-style.md — правила стиля нашей документации: обращение на «вы», простые слова без канцелярита, первое упоминание термина сразу поясняем. Оформи чек-листом.
Внутри может получиться, например, такой чек-лист:
- Обращаемся к читателю на «вы».
- Пишем «используйте» вместо «осуществляйте».
- Новый термин объясняем при первом упоминании.
📝 Кейс 2. Проверить существующую документацию.
Канцелярит — это бюрократический язык: «осуществлять», «в рамках». Искать такие обороты и длинные абзацы вручную утомительно, поэтому поручите поиск Copilot, а решение об исправлениях оставьте себе. Промпт:
Проверь install.md по правилам из doc-style.md: найди канцелярит, длинные абзацы и непояснённые термины. Покажи проблемы списком с цитатами.
📝 Кейс 3. Написать новую документацию.
Черновые заметки есть у каждого техписателя, но собирать из них ровный текст — долгая работа. Copilot напишет раздел в вашем стиле, а вы отредактируете результат как текст коллеги. Промпт:
Напиши раздел «Установка» для инструкции новичка: шаги нумерованным списком, один шаг — одно действие, стиль по doc-style.md. Вот мои черновые заметки: …
📝 Кейс 4. Собрать changelog из истории изменений.
Changelog — список изменений продукта для пользователей. История уже хранится в git — по одному коммиту на каждую порцию правок, — и Copilot может переписать её человеческим языком. Промпт:
Посмотри последние 10 коммитов и собери черновик changelog для пользователей: что нового, что изменилось, что исправлено. Без технического жаргона.
🌼 Упражнение
Выберите кейс, который ближе к вашей работе, и попробуйте его на своём проекте.
1. Скопируйте промпт и подставьте название своего файла.
2. Отправьте промпт Copilot.
3. Прочитайте результат и внесите свои правки.
Получилось? Если нет, то задавайте вопросы в комментариях. 💖