По каким принципам мы пишем гайды по контентным задачам

Мы в группе редакций постоянно и с большой любовью пишем гайды. Они помогают нам снижать хаос, калиброваться по качеству и договариваться друг с другом и заказчиками. Тут вселенная схлопнулась, и мы собрали гайд о том, как пишем гайды — с нашими правилами и принципами. Делюсь с купюрами, но вдруг кого-то вдохновит и поможет.

Лидила разработку гайда — редактор Т-Банка Вика Шестерова

Какие бывают гайды

Гайдом мы называем любой документ, который помогает разобраться, как что-то устроено или как с этим работать. Это может быть инструкция на пару страниц или большой документ с правилами, объяснениями и примерами.

Условно гайды можно разделить на несколько типов:

Тип гайда	Что объясняем	Как можно построить	Пример
Процессный	Как пройти процесс от начала до конца. Например, оформить командировку или уйти в отпуск	Что это за процесс → когда он нужен → что сделать по шагам → к кому обратиться, если что-то пошло не так	Как пройти аттестацию
Инструкция	Как пользоваться инструментом или выполнить конкретное действие. Например, работать в NN или настроить почту	Что это за инструмент → как начать → что делать по шагам → частые вопросы и сложные места	Как проводить созвоны
По формату или задаче	Как работать с конкретным типом повторяющейся задачи. Например, писать нотификации, редактировать вакансии или собирать лендинги	Что это за формат → из каких блоков состоит → правила для контента → примеры → частые ошибки	Гайд по лендингам мероприятий деврелов
Обучающий	Как разобраться в отдельном принципе или подходе. Например, научиться писать транзитивные заголовки	Что это → зачем нужно → как работает → примеры → сложные случаи и исключения	Гайд по транзитивным заголовкам

Редполитика — отдельный формат: к гайдам мы ее не относим. В ней фиксируем правила, по которым пишем тексты для продукта или направления. У редполитик свои особенности, поэтому подробно разбирать их в этом гайде не будем.

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

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

Когда нужен гайд

Основное правило: если вы второй раз объясняете одно и то же, скорее всего, пора это записать.

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

Подумайте о гайде, если:

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

Еще один хороший ориентир — устные договоренности. Если важные правила передаются только в созвонах, переписках или из «рук в руки» часть знаний рано или поздно потеряется. Лучше зафиксировать их там, куда сможет вернуться вся команда.

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

Гайд при этом не обязан сразу быть большим и полным. Начните с того, что уже знаете, а потом дополняйте его по мере работы.

Соберите знания перед тем, как писать

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

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

У темы несколько держателей знаний. Если похожую задачу делают несколько человек, соберите их опыт на созвоне. До встречи подготовьте вопросы по будущей структуре гайда: как коллеги работают, на что обращают внимание и где чаще всего возникают сложности.

Держатель знаний вы. Если какой-то процесс или формат знаете только вы, соберите свой опыт: последовательность действий, частые вопросы, сложные места, договоренности с заказчиком. Постарайтесь вспомнить, что было непонятно, когда вы сами впервые с этим столкнулись.

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

Если пишете инструкцию или процессный гайд, по возможности пройдите этот путь сами. Так проще заметить шаги, которые опытный человек уже делает автоматически и поэтому может забыть объяснить.

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

Продумайте структуру

Хороший гайд ведет по теме последовательно: от вводной информации к деталям и сложным случаям. Читатель не должен возвращаться назад, чтобы понять новый термин, этап или правило.

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

Например, в процессном гайде логично идти от первого шага к последнему

Нет ❌	Да ✅
Согласование → Что это за задача → Работа над текстом → Кто заказчик → Как получить задачу	Что это за задача → Откуда она приходит → Кто участвует в работе → Как подготовить текст → Как согласовать → Что сделать после согласования

В обучающем гайде логика будет другой. Сначала объясните сам принцип, затем — зачем он нужен, как им пользоваться и какие бывают сложные случаи. Например, в гайде по транзитивным заголовкам сначала нужно разобраться, что это за заголовки и как они работают, а уже потом показать примеры для разных форматов и сложных случаев.

Нет ❌	Да ✅
Примеры → Сложные случаи → Что это за принцип → Зачем он нужен	Что это за принцип → Зачем он нужен → Как работает → Примеры → Сложные случаи и исключения

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

Если это один объемный процесс, который человек проходит от начала до конца — оставьте его в одном гайде. Иначе читателю придется собирать инструкцию по нескольким документам.

Пишите для человека без контекста

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

Если упоминаете новый сервис, формат или сокращение, сначала коротко объясните, что это и зачем нужно

Нет ❌	Да ✅
Отправьте гайд на кросс-ревью в NN (название сервиса)	Отправьте гайд на кросс-ревью в NN — внутренний сервис, через который мы отправляем тексты коллегам из других продуктов и оставляем комментарии. Как пользоваться NN — в этом гайде (ссылка)

В первом варианте автор опирается на знания, которые есть у него самого: что такое NN, какой статус считается нужным и зачем его менять. Человеку без контекста придется искать ответы самому.

Не бойтесь объяснять то, что кажется очевидным. Для человека, который давно работает с продуктом, привычный шаг занимает секунду. Новичок может даже не знать, что этот шаг существует

Объясняйте правило и показывайте, как оно работает

Хороший гайд не просто фиксирует правило, а объясняет его логику. Читателю важно понимать не только что делать, но и зачем — тогда правило проще запомнить и применить в новой ситуации.

Не ограничивайтесь фразами «так правильно» или «так не делаем». Если у читателя может возникнуть вопрос «а почему нельзя по-другому?», ответьте на него сразу. Например: пользователю будет сложнее понять текст, команда потратит больше времени на согласование, в макете появится лишний шум или процесс сломается на следующем этапе.

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

Если команда не может объяснить, зачем существует правило, это тоже полезный сигнал. Возможно, оно осталось по привычке и его стоит пересмотреть, а не переносить в гайд как есть

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

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

Проверьте гайд взглядом новичка

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

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

Например, в нашей группе редакций мы отправляем гайды на кросс-ревью коллегам из других продуктов через NN — как пользоваться сервисом рассказали в гайде. Команда оставляет комментарии по тексту и помогает заметить то, что внутри продукта легко пропустить.

Откалибруйте гайд с теми, кого он касается

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

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