Рабочие промпты

Знаю, насколько сложно самостоятельно начать использовать какой-то новый инструмент в работе. Потому хочу показать, какие задачи я решаю сама с помощью ИИ.

Разбила реальные кейсы по тем группам, которые мы с вами определили на мастер-классе.
Для каждой группы привела пример промпта: где-то обобщенный, где-то конкретный.
Промпт можно скопировать, кликнув в правом верхнем углу.

Вдохновляйтесь! 💫

Контекст

У меня есть шаблонный контекст. Я его использую только в совсем обобщенных задачах: например, при брейншторме или подготовке маркетинговых статей. В конкретных задачах я упускаю большую часть деталей, чтобы ИИ не дописывал отсебятину.

Ниже в промптах можно посмотреть, как меняется контекст в зависимости от задачи.

У меня есть продукт Gramax (https://gram.ax/ru) - это система для подготовки технической 
документации и ведения базы знаний. В основе - подход Docs as Code. Основные кейсы использования:
- Документация по проекту: ТЗ, согласование требований, архитектуры, спецификации.
- Документация по продукту: гайды, инструкции, описания.
- База знаний техподдержки: квалификация вопроса, регламенты обработки, ответы.
- База знаний по компании: отпуска и больничные, правила работы, гайды.
- Личная база знаний.

Наша аудитория - прогрессивные it-компании, внедряющие лучшие практики в свои процессы.

Генерация контента

Обычно с помощью ИИ я делаю посты в Telegram-канал. Чаще всего это Release Notes, которые оформляются единообразно. На что обратить внимание:

В промпте почти нет контекста о продукте. Чтобы ИИ не притягивал эту информацию в свои описания.
Задана структура поста и дано указание придерживаться этой структуры.

У меня есть продукт Gramax (https://gram.ax/ru) -- это система для подготовки
технической документации и ведения базы знаний. В основе -- подход Docs as Code.
Наша аудитория -- прогрессивные it-компании, внедряющие лучшие практики в свои процессы.

Работай как профессиональный технический писатель.
Напиши пост в Telegram с Release Notes по версии "Июль 2025".

Формат оформления:

💥 Февраль 2025 💥
📌 Новое расположение действий в статье и каталоге. Облегчили внешний вид правой панели
в приложении — теперь в ней только навигация по статье и настроенные кнопки.
📌 Всплывающая панель для управления ветками. Теперь при клике на название текущей ветки
появляется дополнительная панель, которая не блокирует другие действия в интерфейсе.
📌 Новые языки в блоке кода. Добавили подветку синтаксиса для Dart, Dockerfile, Erlang,
F#, Groovy, Haskell, Julia, MATLAB, Nginx, OCaml, Scala, TOML.
📌 Экспорт в DOCX и PDF в CI/CD. Расширили возможности Gramax CLI: теперь в CI/CD можно
формировать каталог в DOCX или PDF.
О других изменениях читайте в статье — https://gram.ax/resources/docs/whats-new

Сам релиз нотс:

<тут я вставляю текст из статьи в документации>

Строго придерживайся формата оформления поста.
Обрати внимание, что в посте мы сокращаем кол-во описанных фич и сами описания.

Проверка

Иногда я с помощью ИИ вычитываю статьи в документации. Чтобы они были понятными и соответствовали лучшим практикам оформления. На что обратить внимание:

Полный контекст, четкое ТЗ.
Задан формат результата: чтобы получить все комментарии + пример статьи с исправлениями.

У меня есть продукт Gramax (https://gram.ax/ru) - это система для подготовки технической
документации и ведения базы знаний. В основе - подход Docs as Code. Основные кейсы использования:
- Документация по проекту: ТЗ, согласование требований, архитектуры, спецификации.
- Документация по продукту: гайды, инструкции, описания.
- База знаний техподдержки: квалификация вопроса, регламенты обработки, ответы.
- База знаний по компании: отпуска и больничные, правила работы, гайды.
- Личная база знаний.
Наша аудитория - прогрессивные it-компании, внедряющие лучшие практики в свои процессы.

---

Я подготовила статью о настройке шаблона для экспорта в DOCX.
Работать по этой инструкции будет опытный спец: системный администратор или DevOps.

Работай как профессиональный технический писатель и редактор документации.
Твоя задача - вычитать эту статью. Найди ошибки и укажи на них. Предложи, как улучшить структуру,
чтобы читателям было приятнее читать и они сразу разобрались в настройке. Если тебе недостаточно
информации и ты думаешь, что читателям тоже она нужна - задай мне вопросы.

<тут я вставляю текст статьи или прикрепляю файл>

---

Работай с оглядкой на лучшие мировые практики оформления документации.
Сохрани статью короткой и четкой. Пиши только факты, без пространственных рассуждений.
Предварительно изучи пример хорошей статьи:

<тут текст хорошей статьи>

---

Формат результата:
1. Все замечания, рассуждения, предложения и вопросы.
2. Переписанная статья с внесением всех исправлений.

Поиск и фактчекинг

С помощью ИИ я составляю баттл-карты (таблички сравнения Gramax с другими продуктами). Важно учитывать, что для такой работы ИИ выступает очень посредственным помощником, а не автором итогового результата: мы вместе пишем основу, потом я вручную все проверяю или задаю уточняющие вопросы. На что обратить внимание:

Порядок работы с информацией может меняться. Иногда у меня сразу есть список возможностей, иногда я прошу ИИ сформировать его на основе нескольких продуктов.
Нет контекста. Мы работаем с текстом, как с данными. Нам не важны условия.
Много итераций. В одном таком диалоге может быть 20-40 уточнений или корректировок. Для примера привожу первые 3.

Работай как профессиональный аналитик и исследователь. 
Изучи документацию продукта: <ссылка> и все отзывы о нем на открытых площадках.
Напиши список всех возможностей, которыми он обладает. Сгруппируй их в логические блоки.
На каждую возможность прикрепи ссылку на источник.

Дополни этот список возможностями из списка ниже. Размести их в подходящие смысловые блоки.

<тут я вставляю дополнения, которые у меня есть>

Оформи в табличку:
- 1 столбец - пункты из списка ниже.
- 2 столбец - в заголовке напиши Gramax, все остальные строчки пустые.
- 3 столбец - в заголовке напиши Продукт, все остальные строчки пустые.

<тут я вставляю строчки с возможностями продукта>

Структурирование

В нашей работе ИИ очень полезен для оформления баг-репортов на GitHub. Сами проблемы описывают участники в чате комьюнити. ИИ помогает хорошо оформить их на английском.

У меня есть продукт Gramax (https://gram.ax/ru) -- это система для подготовки технической
документации и ведения базы знаний. В основе -- подход Docs as Code.
Так как система Open Source, пользователи могут сообщать о проблемах у нас в чате.

---

Сообщение пользователя:

<тут вставляю сообщение от пользователя>

Уточнения:

<тут пишу порядок воспроизведения или детали, которые знаю о функции>

---

Вот такие термины мы используем на английском языке:
- <термин на ру> - <термин на англ>
- <термин на ру> - <термин на англ>

---

Вот так мы оформляем заявки на GitHub:

< тут вставляю пример заявки>

---

Работай как профессиональный технический писатель и переводчик документации.
Переработай этот баг-репорт в описание для задачи в GitHub на английском.
- Используй только информацию из сообщения пользователя и уточнения. Не придумывай причины.
- Используй нашу терминологию.
- Оформи заявку в соответсвии с примером.

Улучшение и дополнение

ИИ помогает мне вносить исправления в документацию. Например, по комментариям от разработчиков. Или по вопросам, которые возникают у пользователей.

---

У меня есть статья:

<тут я вставляю текст статьи>

---

Пользователь по ней не понимает, как взаимосвязаны все компоненты системы. Его сообщения:

<тут я вставляю все комментарии и вопросы пользователя>

Наш спец ответил ему:

<тут ответ от спеца, который устроил пользователя>

---

Работай как профессиональный технический писатель и редактор документации.
Происследуй статью, дай рекомендации, куда и как добавить информацию.

Перевод и локализация

С помощью ИИ я перевожу нашу документацию на английский язык. На что обратить внимание:

Не стоит запихивать на перевод большие файлы.
Желательно один раз где-то записать всю используемую терминологию. ИИ часто ее опускает и переводит на свой вкус.

Работай как профессиональный технический писатель и переводчик документации.
Переведи статью на английский язык. Используй терминологию из списка ниже:
- <термин на ру> - <термин на англ>
- <термин на ру> - <термин на англ>
...

<тут я вставляю текст статьи в разметке>

Формат результата:
1. Переведенная статья с использованием терминологии выше.
2. Оформление в Markdown с использованием элементов как в русскоязычной статье.

Брейншторм

Тут сложно сделать обобщенный пример, потому покажу конкретно 😇.

У меня есть статья - https://gram.ax/resources/docs/collaboration/resolve-conflicts
У системы есть нетехнические пользователи, которые не знают, как устроен Git.
Они не понимают природу конфликтов: как и почему они возникают. Также пугаются, когда видят
окно решения конфликта.

Работай как очень заботливый и участливый технический писатель.
Предложи, как улучшить статью. Она не должна раздражать технических пользователей дотошными
и детальными описаниями. Но должна успокоить нетехнических пользователей: показать им, что
конфликты не страшные. И возможность решать их вручную - круто!

Используй терминологию и стандарты оформления нашей документации. Примеры:
- https://gram.ax/resources/docs/storage/other-git-storages
- https://gram.ax/resources/docs/collaboration/merge-request

Расшифровка мастер-класса

Наши общие боли