Начнём 2025-й с полезного.

Дело в том, что в июле прошлого года у нас ещё не было канала, поэтому мы вам не рассказали, что совместно с дизайнерами сделали ToV и гайд для текстов в интерфейсе.

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

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

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

Боязнь чистого листа

Фобия, с которой чаще остальных сталкиваются начинающие технические писатели. С чего начать написание инструкции? Как бы начать так, чтобы потом не переписывать?

У нас есть два небольших совета:

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

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

Ну а что делать с боязнью переписывать? Тут просто принять тот факт, что переписывать или вносить правки всё равно придётся. И, скорее всего, не один раз😉

А у вас бывает страх чистого листа? Как справляетесь?

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

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

И вот, программа конференции, наконец, сформирована! 🎉 Просто пробегитесь по заголовкам докладов, это праздник какой-то 😉

В два дня конференции уместились больше 60 докладов и мастер-классов 😱
И наш главный вопрос — как разорваться между сразу 4 секциями, в каждой из которых интересный доклад 🥲😁

Какие доклады больше всего ждете? Какие названия вас больше всего заинтриговали?

_______
Несколько полезных ссылок:
Билеты
Скидки
Канал и чат конференции

Не, ну так-то все понятно 😄

Уведомление в одном из популярных приложений, где, видимо, решили, что UX-райтер не нужен...

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

Пиши сокращай проверяй

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

✏️ Вычитывайте вслух. Незаметные глазу шероховатости очень хорошо слышно. Если спотыкаетесь — это верный признак, что лучше упростить предложение.

✏️ Когда вычитываете, представляйте себя в разных ролях: новичок, продвинутый пользователь, редактор.

✏️ Сделайте паузы перед итерациями вычитки, хотя бы 30 минут. И в следующий подход документ будет восприниматься свежим взглядом. Не зря говорят: «утро вечера мудренее».

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

✏️ И наконец, прислушивайтесь к своему внутреннему голосу. Если вам кажется, что что-то не так — вам не кажется. Попробуйте переписать или перефразировать ваше предложение.

Дополняйте наш список и делитесь своими советами в комментариях.

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

Заказчик-перфекционист: когда правок не счесть

Сегодня в рубрике #давайте_про_заказчиков новый герой — заказчик-перфекционист.

Он стремится к совершенству, поэтому без остановки критикует ваш текст, а согласование растягивается на огромное количество итераций. Знакомо?

Если вы, как и мы, не любите править поправленное до бесконечности, берите наши лайфхаки на заметку:

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

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

#давайте_про_заказчиков
#давайте_лайфхак

Было?
#давайте_мем

Если есть профессия, есть и ее день :-)
Технические писатели пока не определились, когда праздновать.

Но есть две версии, которые нам нравятся:
🔸 1 февраля — потому что кнопка F1 (February, 1) обычно вызывает Справку в приложении.
🔸 2 февраля — потому что это 33-й день года, а в русском алфавите 33 буквы (актуально для тех, кто пишет на русском)

Но в любом случае это либо сегодня, либо вчера. Так что поздравим друг друга! :-)

#давайте_про_профессию

Наши любимые стайлгайды

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

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

Стайлгайды на русском языке:

Госуслуги
Ozon
Райффазен банк
Модульбанк

Стайлгайды на английском языке:

Google Developer Documentation Style Guide
Google technical writing one guide
Microsoft Writing Style Guide
SUSE Documentation Style Guide

#давайте_лайфхак
#давайте_про_стайлгайд

Техпис в команде разработки: чужой среди своих?

Какое место занимает технический писатель в команде разработки? Мы провели опросы наших коллег и узнали, что бывает по-разному. В итоге мы выделили четыре типичных модели, у каждой из которых свои плюсы и минусы.

Найдите себя на нашей системе координат. Для этого оцените:

🖌 Включенность. Вы хорошо знаете всех членов команды и их обязанности? Ходите на общие встречи? А в неформальные чатики добавлены? Все знают, кто вы и чем занимаетесь?

🖌 Организованность. Есть четкое понимание, кто в команде ставит вам задачи и принимает их? А есть ли они в таск-трекере команды? Как насчет контроля и отчетности?

Чем больше организованность, тем выше ваша точка. Чем больше включенность, тем она правее.

Нашли себя в одном из квадратов? Расскажите в опросе ниже!

Конечно, любая классификация условна, и в чистом виде эти типы встречаются не так часто.

Подробнее про каждый тип — в комментариях к этому посту.

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

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

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

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

В итоге правильно оформленная инструкция по походу в супермаркет будет выглядеть примерно так:
=====
1. Найдите на полках товары по списку:
— молоко;
— хлеб;
— яйца;
— сыр;
— чай.
2. Положите товары в корзину.
3. Оплатите товары на кассе.
4. Сложите покупки в пакет и бегите домой ужинать.
======
P.S. Кстати, знаки препинания в списках у нас регламентированы стайлгайдом и они не случайно расставлены здесь именно так :)

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

Заказчик-формалист: тонкости согласования

Ваш заказчик обожает сухой, формальный язык с огромным количеством канцеляризмов и сложных конструкций? Поздравляем! Вы имеете дело с заказчиком-формалистом. Обычно тексты после правок такого заказчика напоминают юридический договор — запутанный, сложный для восприятия и перегруженный лишними деталями.
Но не спешите отчаиваться! Есть эффективные приемы, которые помогут вам отстоять свою точку зрения и выйти победителем в этом противостоянии:

✅ Для формалистов самый убедительный аргумент — это наличие прописанных стандартов. Поэтому всегда cсылайтесь на Стайлгайд и Tone of voice вашего продукта.

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

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

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

Чего делать нельзя? Принимать правки, которые усложняют восприятие текста пользователями, потому что технические писатели все-таки пишут для пользователей, а не для заказчиков.

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

#давайте_лайфхак
#давайте_про_заказчиков

Как вам на вкус наш гель для душа? 😁

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

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

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

Необидная обратная связь

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

Собрали несколько советов, как не поссориться с коллегой и помочь ему советом:

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

✅ Не тыкайте коллегу носом в то, что он пропустил какой-то кейс. Можно аккуратно сформулировать наводящий вопрос. Например, если в тексте речь идет о способах оплаты заказа, можно поинтересоваться: «А оплатить СБП можно?».

✅ Не будьте слишком категоричными. Из многих правил есть исключения. В первую очередь думайте о том, как это будет читать пользователь. Например, мы иногда сталкиваемся со случаями, когда причастный оборот, запрещенный по стайлгайду, воспринимать легче, чем конструкцию «... , который».

✅ Обсудите «голосом». Если вам все-таки кажется, что ваш комментарий звучит как проклятье, и вам не хочется показаться токсичным в тексте, наберите коллегу на пять минут. Уверены, ваша беседа пройдет мягко и максимально корректно.

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