Как понять, что скриншоты в инструкции не нужны?

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

Сложность интерфейса. Если он простой и неперегруженный, скрины скорее всего вообще не нужны.

Целевая аудитория. Для суперопытных пользователей скрины будут лишними и вызывать только раздражение. Больше вашу инструкцию пользователи не откроют.

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

А сколько скринов в ваших инструкциях?

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

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

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

Удивительный мир заказчиков: заказчик неуловимый

Начинаем увлекательную рубрику #давайте_про_заказчиков. Был ли у вас заказчик, который всегда занят и долго не отвечает? Уверены, с таким заказчиком сталкивался хоть раз каждый, а если не сталкивался, обязательно столкнется.
Делимся своими лайфхаками взаимодействия с неуловимыми заказчиками и рассказываем, что может помочь до них достучаться:

✅ Напоминайте о себе по разным каналам связям. Необязательно звонить в 2 часа ночи, достаточно написать в нескольких меcсенджерах.

✅ Указывайте дедлайн для ответа. Заказчик будет знать, сколько у него есть времени на обратную связь. Да и дедлайн — отличная мотивация с ней не затягивать.

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

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

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

А что делаете вы, если ваш заказчик долго не отвечает?

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

Не успели мы анонсировать один митап, как узнали еще про один, на этот раз в Москве и онлайн. Не можем не поделиться!

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

💯

Кидайте свои мемчики о работе в комментарии 🙂

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

Когда таблица становится монстром

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

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

Вот несколько рекомендаций, чтобы таблица не превратилась в монстра:

✅ Проверьте, что таблица помещается на странице по ширине — все столбцы видны.
✅ Постарайтесь, чтобы столбцов было как можно меньше, так легче воспринимается информация. Например, в нашем примере можно объединить столбцы «Дни работы» и «Время работы» в один — «График работы».
✅ Понятно назовите каждый столбец. Общее «Название» можно уточнить и сделать «Название склада».
✅ Используйте в ячейках таблицы разные блоки, чтобы упростить и структурировать: абзацы, примечания, списки, каты и табы.
✅ Если вы видите, что в ячейках повторяется одна и та же информация, попробуйте вынести ее из таблицы. Таблица станет «воздушнее».

В комментах покажем, как мы упростили таблицу, чтобы читателю она стала понятнее.

А встречали ли вы табличных монстров? Как боролись с ними? Расскажите о вашей практике!

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

Дедлайн — вчера. Как выжить в режиме аврала

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

Хотите узнать про наш сценарий спасения?

1. Очистите календарь от лишних встреч, чтобы освободить время на работу.

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

3. Посчитайте, сколько примерно времени займет каждая задача.

4. Составьте план работы на каждый день недели.

5. Забронируйте время в своем календаре для работы над определенной задачей.

6. Оставляйте в графике свободные слоты на внезапные задачи.

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

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

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

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

И, наконец, cнизьте градус перфекционизма. Пытаться объять необъятное и успеть вообще всё — прямой путь к неврозу и антидепрессантам. Неотложных дел в нашей жизни не так уж много. Весь мир может подождать, пока вы выдохнете, соберетесь с силами и выстроите свой план работы.

А что помогает вам в режиме аврала?

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

Обратиться в техписа

Насколько нам известно, в дипломе ни у одного из технических писателей не написано «Разработка технической документации». А что написано? Люди каких специальностей становятся техписами?

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

Впрочем в современном мире люди не всегда работают по специальности и часто по несколько раз меняют профессии на протяжении жизни. Из каких же профессий чаще приходят в техписы?

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

Отсюда и два направления; откуда перебраться в техписы проще всего:

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

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

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

А что написано у вас в дипломе и из какой профессии вы перешли в техписы? Было ли это сложно? Чему пришлось доучиться?

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

Кат или не кат? Вот в чем вопрос

Кат? Спойлер? Или все-таки аккордеон? Блок текста, который раскрывается только по клику. В разных компаниях их называют по-разному. Сегодня хотим обсудить не название, а кейсы, когда этот способ отображения информации подходит.

Когда каты — хорошая идея

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

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

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

✅ Для дополнительных скринов. Подробно разбирали это в посте ранее.

✅ Когда нужно показать образец. Например, хотим показать как заполнить какой-то документ.

Но у катов есть достаточно серьезные недостатки, о которых точно нужно знать:

— В некоторых сервисах поиск по странице может не найти то, что спрятано под катом.

— Есть риск, что под катом окажется важная информация, а пользователь его не откроет и не прочитает.

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

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

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

Все ещё считаете, что наша профессия — для интровертов? ;-)

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

Инструкция или FAQ?

Надо ли создавать раздел вопросов и ответов, если уже есть пользовательские инструкции? А наоборот? Если есть FAQ, может инструкции не нужны?

Мы думаем, идеально иметь и то, и другое. И связать их между собой.

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

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

Давайте на примере.
Вопрос из FAQ интернет-магазина: «Можно ли отменить уже оплаченный заказ?». В ответе мы должны только рассказать о том, что такая возможность, допустим, существует, и кратко описать, на каких условиях это происходит. Давать пошаговую инструкцию о том, как именно это сделать, в какие разделы идти и на какие кнопки нажимать, тут не нужно. Пользователь только спросил о возможности, он может быть еще на этапе решения о том, делать ли заказ («Если можно отменить, если что, закажу»). Но после прямого ответа на вопрос мы можем дать ссылку на раздел руководства, где дается пошаговая инструкция по отмене.

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

А если я не хочу жаловаться? 😕😄

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

Вызывайте техписа! А когда пора?

Мы уверены, что лучшее время — когда сервис еще в процессе разработки (а вовсе не за два дня до релиза, как часто бывает).

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

✔️ Если нужны только инструкции, оптимально начинать работу, когда уже утверждены макеты, а еще лучше когда готов тестовый стенд. Если начать до этого момента, есть риск, что инструкции придется переписывать несколько раз вслед за изменениями в интерфейсах.
___
Это идеальный вариант. В реальной практике техписы подключаются к задачам на самых разных этапах. И, конечно, лучше поздно, чем никогда.

А вы что думаете? Бывает ли слишком поздно? А слишком рано?

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

Это просто праздник какой-то! Один митап за другим. Только недавно слушали крутых спикеров в доме Cloud, как появилось приглашение на митап в Ozon.
Регистрируйтесь скорее 😉

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