Всё так? ;-)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Например:

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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

25 августа 2025
Москва
WriteConf — конференция для всех, кто работает с текстами: технические писатели, UX-редакторы, контент-менеджеры, локализаторы и т.д.

2-3 октября 2025
Санкт-Петербург
Большая IT-конференция «Стачка» с традиционно сильной секцией про тексты.

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

____
Если знаете что-то еще, пишите в комментариях.

По нашей инсайдерской информации осенью еще ожидаются митапы для техписов сразу от нескольких IT-компаний ;-)
По мере появления подробностей будем дополнять пост. Stay tuned!

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

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

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

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

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

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

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

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

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

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

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

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

Задача — сделать стайлгайд. Идеальная структура

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

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

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

🔹Требования к структуре документа
🔹Требования к структуре страницы
🔹Лексика
🔹Типографика и специальная пунктуация
и т.д. в зависимости от того, что проверяете вы.

Резонный вопрос: а как же БАЗА? Где написать основные постулаты и правила? Если их будет немного — им место на главной странице. Если правил приличное
количество — выделите их в отдельный раздел в самом начале документа.

А какая структура гайда у вас?

#давайте_практику #давайте_про_стайлгайд

Давайте розыгрыш!

Ровно через месяц, 25 августа, нас ждет классное мероприятие — WriteConf. Вместе соберутся все, кто работает с текстами — технические писатели, UX-редакторы, контент-маркетологи и многие другие.

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

Заинтересовали? Хотите поучаствовать?

Разыгрываем онлайн-билет среди наших подписчиков. А это:
✅ Доступ к онлайн-трансляции
✅ 3 потока лекций по Write
✅ Записи всех докладов

Как выиграть билет
1. Подписаться на канал конференции и наш канал, если еще не подписаны.
2. Написать любой комментарий под этим постом.
3. Дождаться розыгрыша 1 августа — каждому комментарию от одного пользователя присвоим порядковый номер, а потом запустим генератор случайных чисел.

Поехали!

Дефисы, запятые и другие монстры: как укротить орфографию

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

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

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

✅ Не ленитесь и перечитывайте то, что вы написали. Чтение вслух или пословно с конца — это вообще суперспособ: сразу заметите, если пропустили что-то важное.

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

✅ Установите надежный редактор, который подчеркнет каждую запятую, поставленную не туда, и «закричит», если вы нечаянно написали «кноппка». Word, Google Docs, Grammarly — неплохие варианты.

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

✅ Используйте чудесные онлайн-сервисы. Введите текст в «Главред», чтобы убрать лишние стоп-слова. Закиньте текст в любую программу проверки орфографии, чтобы отловить неловкие опечатки.

✅ Оставьте текст «на потом». Да, серьезно. После перерыва шансы обнаружить собственные ошибки гораздо выше.

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

✅ У каждого — свои «любимые» ошибки. Кто-то ставит везде лишний дефис, кто-то обожает длинные предложения без единой запятой. Создайте чек-лист своих «коронных» ошибок и проверяйте свои тексты по этому списку. Кстати, какая у вас? Расскажите в комментариях 😉

В общем, ленитесь в чем угодно, но не в проверке своего текста. Мы все порой совершаем ошибки. Главное — вовремя их найти и обезвредить!

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