Escrita
RU
Обсудить проект
Меню
Контент

Как составить бриф на техническую статью

Четыре вопроса, с которых можно начать.

Тема «интеграции в нашем продукте» оставляет слишком много вопросов. Бриф помогает выбрать один сценарий, собрать источники и заранее определить, что читатель получит от статьи.

Четыре вопроса для брифа

  1. Кто читает? Укажите роль и стартовый уровень. Разработчику, который уже подключил API, нужны одни детали. Руководителю, который оценивает внедрение, — другие.
  2. Что читатель сможет сделать? Опишите действие. Например: «Найти событие в журнале и разобраться, почему оно не дошло до получателя».
  3. Что подтвердит детали? Приложите нужные разделы документации, пример и уточнения специалиста. Отметьте, к какой версии продукта они относятся.
  4. Когда текст готов? Сформулируйте проверку. Например: читатель может повторить шаги, а специалист подтверждает, что пример соответствует указанной версии продукта.

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

Подготовим техническую статью

Расскажите о продукте и аудитории. Поможем выбрать тему, формат и структуру.

Обсудить проект