IT и разработка

Технический писатель — документация и инструкции

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

Коротко
  • Что делает. Инструкции для сотрудников и пользователей
  • Кому подойдёт. Подойдёт командам, где знания живут в головах, и разработчикам, которым надо описать проект так, чтобы новый человек…
  • Сколько стоит. Около двух копеек за сообщение: отвечает самая дешёвая модель каталога, подписки нет, новому аккаунту 30 ₽ на баланс.
  • Чего не делает. Поведение вашей системы он не знает: недостающее пометит вопросом
Открыть в чате →
Открыть ассистента в чате Нужен аккаунт: регистрация через Яндекс ID или почту, новому аккаунту кладём 30 ₽ на баланс. Без аккаунта работает обычный чат — три сообщения в сутки.

Документацию не пишут не потому, что сложно, а потому, что скучно и непонятно, с чего начать. Ассистент снимает обе проблемы: превращает ваш рассказ «как я это делаю» в последовательность шагов с проверками и предупреждениями.

Ключевое требование к инструкции — по ней должен пройти человек не из команды. Поэтому в тексте появляется явный результат каждого шага и раздел «если пошло не так», без которого инструкции обычно и ломаются.

Что умеет

  • Инструкции для сотрудников и пользователей
  • README и описание запуска проекта
  • Описание методов API с примерами запроса и ответа
  • Перевод технического текста на человеческий язык

Что пишут чаще всего

Инструкция для сотрудников

Как выгрузить отчёт, оформить заявку, подготовить рассылку. С шагами, скриншот-заглушками и типичными ошибками.

README и запуск проекта

Требования, установка, конфигурация, запуск, частые проблемы. Формат, который экономит часы новому разработчику.

Описание API

Метод, параметры, пример запроса и ответа, коды ошибок и что делать при каждой.

Пример: запрос и что приходит в ответ

DSТехнический писатель
Читатель — новый менеджер. Процесс: выгрузить отчёт по продажам из админки, привести в таблицу и отправить клиенту до 10 утра понедельника.
«Шаг 1. Откройте админку → Отчёты → Продажи. Результат: видите таблицу за текущий месяц. Шаг 2. Установите период: прошлая неделя, с понедельника по воскресенье… Если пошло не так: отчёт пустой — проверьте фильтр по складу, по умолчанию стоит „Основной“…»

Ответ приведён в сокращении: в чате он длиннее и его можно попросить переделать — короче, другим тоном, в виде таблицы.

С чего начать

Нажмите пример — он откроется в чате уже вписанным в поле ввода, останется поправить под себя и отправить.

Напиши инструкцию для сотрудника: как выгрузить отчёт из админки и отправить клиенту. Открыть в чате → Собери README для скрипта на Python, который парсит прайсы и складывает в CSV. Открыть в чате → Опиши метод API для создания заказа: [вставьте детали]. Открыть в чате →

Как это работает и сколько стоит

Ассистент — это чат с уже настроенной ролью: системный промпт задан заранее, объяснять модели, кем ей быть, не нужно. Отвечает DeepSeek V4 Flash — самая дешёвая модель каталога: обычное сообщение с развёрнутым ответом обходится примерно в две копейки, и её хватает на подавляющее большинство задач. Нужна модель посильнее — переключите её прямо в чате, роль при этом останется.

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

Как получить инструкцию, по которой пройдут

Расскажите процесс так, как делаете сами, включая мелочи.

  • Кто читатель: коллега, клиент, разработчик
  • Что у человека уже должно быть: доступы, аккаунты, установленные программы
  • Пошаговый рассказ своими словами, даже сумбурный
  • Где обычно ошибаются и что тогда происходит
  • Что считается успешным результатом

Готовый шаблон запроса

Скопируйте, подставьте свои данные и отправьте — этого достаточно, чтобы получить рабочий ответ с первого раза.

Читатель: [коллега / клиент / разработчик]
Что должно быть у человека заранее: [доступы, программы]
Процесс своими словами: [как вы делаете это сами, по шагам]
Где обычно ошибаются: […]
Собери инструкцию с явным результатом каждого шага и разделом «если пошло не так».

Слабый запрос и рабочий: в чём разница

Так не надо
Напиши инструкцию.
Без процесса и читателя инструкция получится ни для кого.
Так сработает
Инструкция для нового менеджера: выгрузить отчёт по продажам из админки за прошлую неделю и отправить клиенту до 10 утра понедельника. Ошибаются на фильтре склада.

Как проверить результат

Ответ нейросети — это черновик, а не готовое решение. Перед тем как пускать его в дело, пройдитесь по короткому списку.

  • По инструкции прошёл человек, который не делал этого раньше
  • У каждого шага есть проверяемый результат
  • Описаны типичные ошибки и что делать
  • Указаны дата и владелец документа

Частые ошибки

  • Пропускать очевидные для себя шаги: именно на них и спотыкаются новички
  • Писать «нажмите кнопку», не сказав, где она находится
  • Оставлять инструкцию без даты и владельца — через полгода никто не знает, актуальна ли она

Кому подойдёт, а кому нет

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

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

Чего он не делает

  • Поведение вашей системы он не знает: недостающее пометит вопросом
  • Скриншоты и схемы не делает — только текст

Частые вопросы

Как получить инструкцию, по которой реально пройдут?

Опишите шаги так, как делаете сами, включая мелочи. Ассистент превратит это в последовательность с проверками и предупреждениями о типичных ошибках.

Подойдёт для внутренних регламентов?

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

Он сделает скриншоты?

Нет, только текст. Но разметит, где нужны изображения и что на них должно быть видно.

Подойдёт для внутренних регламентов?

Да, формат тот же: шаги, ответственные, исключения и что делать, если процесс встал.

Он опишет мой API по коду?

Если вставите код или спецификацию — да, соберёт описание методов с примерами. Придумывать поведение по названию функции он не станет.

Открыть «Технический писатель» в чате

Разборы по теме в блоге

Если хочется не просто открыть ассистента, а разобраться, как модель справляется с задачей и где ошибается: нейросеть для документов · нейросеть для программирования. Полный список материалов — в блоге.

Другие ассистенты

Из того же раздела «IT и разработка»: Программист · SQL-помощник · Ревьюер кода. Полный список — в каталоге ИИ-ассистентов, отдел целиком — it и разработка.

Похожие по задачам: Программист · Деловая переписка · Редактор-корректор.