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

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

Но есть две версии, которые нам нравятся:
🔸 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-редактор, и технический писатель вслед за любым изменением в продукте должен проанализировать, где и какие тексты теперь нужно переписать.

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

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

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

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

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

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

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

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

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

Чек-лист оформления инструкции

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

🔲 Заголовки разделов инструкции выстроены в четкой иерархии
🔲 Добавлено оглавление (если в инструкции больше двух разделов)
🔲 Текст разбит на абзацы: один абзац — одна тема
Нет абзацев длиннее 7 строк
🔲 Порядок действий оформлен как нумерованный список
🔲 Перечень оформлен как маркированный список
🔲 Блок схожей информации оформлен в таблицу
🔲 Формат примечаний соответствует их содержанию
🔲 Критичные предупреждения вынесены в примечания
🔲 Элементы интерфейса выделены жирным шрифтом, в других случаях жирный шрифт не использован
🔲 В тексте нет курсива, подчеркиваний, шрифта другого цвета или размера
🔲 Все гиперссылки содержательны (нет ссылок на словах «здесь», «по ссылке» и т.п.)
🔲 Скриншоты использованы только в ситуациях, когда без них текст непонятен
🔲 Информация, нужная только небольшой части аудитории, убрана под каты
🔲 Параллельные сценарии оформлены в табы (вкладки)

Спрашивайте, если нужно что-то пояснить :)

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

С добрым утром, коллеги! Как ваш взгляд сегодня? 😁

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

Как написать проще?

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

Здесь важно уйти с уровня отдельных слов.

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

Давайте на примере. Вот какой диалог мог бы состояться:

— Слушай, у меня дурацкая фраза, которую я никак не могу упростить. «Пройдите регистрацию, чтобы избежать возможных проблем с удалением объявления».
— Звучит, и правда, как не слишком понятная угроза. А что именно ты хочешь этим сказать? Объясни мне.
— Ну смотри, там какая ситуация. Если он даст объявление и не зарегистрирован, то он может его удалить, пока страница еще открыта. Но если позже захочет, то уже не выйдет. А если зарегистрирован, то всегда сможет войти в личный кабинет и удалить.
— Вот теперь понятно! Так и напиши.
— «Зарегистрируйтесь на сайте, если хотите иметь полный доступ к управлению объявлениями. Удалить объявление, которое вы дали без регистрации, можно только сразу после размещения. Регистрация позволяет в любой момент найти объявление в личном кабинете и удалить его».
— Отлично! Да, так длиннее, зато намного понятнее. Если переживаешь, что слишком длинно, все пояснение можно вынести в примечание или даже убрать под кат.

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

Попробуйте, это работает :)

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

Включаем креатив — что произойдёт, если пользователь нажмет загадочную кнопку «20 мин»? 🤯😁

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

Тайна за семью печатями: 
заказчик-конспиратор

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

Делимся советами:

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

Чего точно делать нельзя? Это ограничиваться своим таинственным заказчиком и той скудной информацией, которую удалось из него вытащить. А какие лайфхаки используете вы с заказчиками-конспираторами?

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

В ближайшие два дня авторский коллектив нашего канала в полном составе на Techwriter Days #2 🎉

А некоторые даже выступают (об этом расскажем отдельно)

Узнали нас? Подходите знакомиться ;-)