Поговорим о качестве?

Главные критерии качества текста — польза, актуальность и полнота. Если инструкция бесполезна, неактуальна или недостаточна, то не имеет значения, как вы ее оформите и как сформулируете, — все придется переделать. Работа над этими критериями занимает больше всего времени, и оценить их сложнее всего. Делимся с вами нашими лайфхаками!

Как понять, полезен ли читателю текст? Поставьте себя на его место и подумайте, как он будет пользоваться продуктом, какие задачи будет решать. И пишите только о том, что важно.
Пропускайте через сито пользы каждое слово: нужно ли это пользователю, будет ли он это применять? Всё, что можно убрать без потери смысла, нужно убрать, тогда в итоге останется чистая польза.
Например, пользователю не важно знать, как технически устроена отправка сообщений, но важно знать, как заполнить форму, чтобы сообщение точно отправилось.

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

Чтобы проверить полноту инструкции, пройдите по пути пользователя и посмотрите по сторонам: что еще ему может понадобиться? Может, дать ссылки на ресурсы, добавить шаги, указать требования к файлам или более детально описать процесс? Сделайте всё, чтобы пользователь мог решить свою задачу здесь и сейчас.
Особое внимание уделите внешним процессам: если пользователю нужно что-то сделать вне продукта, облегчите его путь максимально. Нужно отправить документы? Расскажите, в каком формате, куда, как именно. Пользователь все равно задаст себе эти вопросы, так что лучше заранее дать на них ответы.

На сегодня, пожалуй, всё!
А как научиться предвидеть вопросы пользователя, расскажем в следующей серии рубрики #давайте_лайфхак )

Всё так? ;-)

#давайте_мем

Правила хорошего тона хорошей инструкции

Инструкция — главный продукт техписа. И вот что, на наш взгляд, отличает хорошую инструкцию от плохой.

✅ Одно действие — один шаг
Например, «Зайдите в раздел, потом нажмите кнопку Создать, после чего заполните форму» — это три последовательных шага, а не один. Разделите их на три пункта нумерованного списка.

✅ Только повелительное наклонение
«Нажмите», «перейдите», «выберите» и никаких «нажимаем», «необходимо перейти» и «выбрать». Проверьте себя — в каждом шаге инструкции должен быть подобный глагол.

✅ Шаги — про действия пользователя, а не системы
«Форма для заполнения откроется в новом окне» — это не шаг для пользователя, а результат выполнения его предыдущего действия. Не создавайте новый пункт списка, напишите про этот результат в конце предыдущего пункта: «Нажмите Создать. Откроется форма для заполнения». Каждый шаг инструкции должен описывать то, что может сделать сам пользователь.

✅ Для опциональных шагов — «если» в начале вместо пояснений в конце
«Если хотите добавить комментарий к заявке, откройте…» — так читатель сразу пропустит этот шаг, если он не хочет добавлять комментарий.

✅ Заголовок — про целевое действие
Какой результат получит пользователь, когда пройдет все шаги? Создаст заявку? Тогда назовите инструкцию конкретно «Как создать заявку», а не туманно «Работа с заявками».

#давайте_практику

Тестовое задание: как догадаться, чего от вас ждут

Бывало ли, что вы получали тестовое задание написать текст, но не понимали, чего от вас ждут? Ведь далеко не все задания выглядят как «Вот задание, а вот требования к нему». Что же делать в таких случаях?

Самое правильное и очевидное решение — спросить. Обычно все общение ведется с HR-специалистом, через него можно задать вопросы нанимающему менеджеру.

Если HR молчит или пришел ответ, что требований нет:

✅ Почитайте публичные тексты компании и попробуйте найти их гайд. А если есть инструкции в публичном доступе, их изучите особенно внимательно.

✅ Проанализируйте тексты ближайших конкурентов.

✅ Изучите в описании вакансии раздел Требования к кандидату, в них обычно описан формат документов и подход, в котором работают в компании.

✅ Сделайте ваш текст подробным настолько, насколько этого требует целевая аудитория. Для крупных b2c-сервисов часто нужны подробные инструкции, а если вам нужен текст для сегмента IT4IT, больше обратите внимание на условия, ограничения и т.п., а описание «кнопочек» и действий с ними можно минимизировать.

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

А в комментариях можно поделиться вашей историей выполнения тестового без четких требований 😉

#давайте_практику

Всё так? ;-)

#давайте_мем

База знаний в порядке: еще одна роль техписа

Была ли у вас ситуация, когда ищешь информацию в базе знаний, а там дремучий лес?
И вроде создание и ведение базы знаний не прямая обязанность технического писателя, но иногда так хочется навести порядок и помочь сделать непонятное понятным… Так почему бы и нет? 🙂
Мы собрали несколько пунктов, чем технический писатель может помочь:

✅ Провести ревизию базы знаний и проверить актуальность статей в ней. Ведь одна из наших задач на вычитке - как раз убедиться, что информация достоверна.

✅ Создать удобную структуру. Кто, если не мы, сможет разобрать все статьи, объединить их в разделы и выстроить все логично и понятно?

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

✅ Создать шаблоны для оформления статей и написать словарь терминов. База знаний понятнее и проще, если она единообразна. Шаблоны помогают одинаково оформить статьи, а словарь терминов - использовать авторам одинаковые названия для одних и тех же сущностей.

✅ Написать инструкцию, как выпускать статьи в прод. Если авторов несколько, то инструкция точно выручит.

У вас есть идеи, чем ещё технический писатель может помочь? Пишите в комментариях.

#давайте_про_процессы

Задача — сделать стайлгайд. С чего начать?

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

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

✅ Уточните, есть ли уже какие-то гайды у коллег в компании. Очень вероятно стайлгайд уже может быть у дизайнеров в черновом формате, ToV как старт для стайлгайда можно подсмотреть у DevRel’ов или маркетологов.

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

✅ Очертите круг задач: гайд для каких текстов вы будете делать. Ведь часто техписы пишут не только техническую документацию, но и новостные рассылки, тексты для интерфейсов, чат-ботов и т.д.

✅Начните записывать идеи. Просто накидывать все, что хотели бы отразить в гайде: требования к стилю, построению текста, словам и т. д.

Что делать дальше? Обсудим в одном из следующих постов.
#давайте_практику #давайте_про_стайлгайд

Как правильно? Правильно — никак

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

Чекбокс? А что с ним тогда делают? Отметить в чекбоксе? Заполнить чекбокс? Поставить галочку в чекбоксе? А, может быть, это все же флаг или флажок? Некоторые и вовсе настаивают на «переключателе с независимой фиксацией» ;-)

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

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

Просто расскажите, что нужно сделать именно в вашем интерфейсе.

Например:

— «Отметьте дополнительные услуги, которые вам потребуются»
— «Выберите параметры, которые подходят для вашего проекта»
— «Снимите отметку с тех предложений, которые больше не актуальны».


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

Кстати, это касается и других элементов интерфейса. Если можно обойтись без термина, лучше так и сделать. Избавьте пользователя от нашего птичьего языка с его чекбоксами, радиобаттонами и модалками. Даже кнопку вовсе не обязательно называть в инструкции кнопкой. «Нажмите Сохранить» будет вполне достаточно.

#давайте_практику

На примере одной этой модалки можно сделать целый курс про то, как не надо писать интерфейсные тексты :-)

Видим минимум 5 фейлов, расскажем чуть позже в комментах. А вы сколько насчитаете?

#давайте_фейл

Трудности перевода: инструменты для локализации

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

Чтобы процесс локализации был качественным и быстрым, нужны правильные инструменты с правильными возможностями. Например, Smartcat, Passolo или Trados.

И вот, почему они нам так нравятся.

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

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

✅Глоссарии
Можно создавать собственные словари терминов.

✅Автоматическая проверка ошибок
Инструменты автоматически укажут на несоответствия в текстах — отсутствие тегов, ошибки, опечатки или некорректный перевод.

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

✅Персональный подход
Можно подобрать оптимальные настройки инструмента именно для вашего проекта.

А какие инструменты для перевода и локализации используете вы?

#давайте_про_инструменты

Календарь техписа

Это закрепленный и постоянно обновляемый пост с анонсами мероприятий, которые могут быть интересны техпису.

26 февраля 2026
Москва
WriteConf — конференция для тех, кто пишет тексты в IT.

27-28 марта 2026
Москва и онлайн
Главная конференция для технических писателей TechWriter Days, третья по счету.

#давайте_анонс

А так понятно?

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

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

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

Посмотрим на примере, как работают эти приемы.

Чтобы проверить заморозку клиентов из КГ и ЦГ, включите опцию Проверять группы.

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

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

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

Проверять свои тексты на понятность продолжим в следующей серии, не переключайтесь )

#давайте_перепишем #давайте_лайфхак

Готовим для вас очередной пост про стайлгайд, принесли мемчик в тему.
💔 — если болит

#давайте_мем