Shut up and write
715 subscribers
42 photos
2 files
139 links
Я Маша и я технический писатель. Очень люблю документацию, особенно хорошую. Читаю все подряд: инструкции к стиральным машинам, правила пользования метро и справки разных сервисов.
На канале пишу о том, что понравилось или не понравилось.
@the_real_mari
Download Telegram
Как пользоваться кассой?
#бытовуха #примеризжизни

Посмотрим, как сделана инструкция для кассы самообслуживания. За пример спасибо @sobolevskayam.

Что мне не понравилось:
- заголовок с неважной темой
- жирный шрифт то там, то тут
- картинки, которые занимаю место, но не помогают
- недосказанность, нужно слишком много думать (что делать с овощами? зачем обновлять QR-код?)
- где-то цифры убежали от текста
- последовательность шагов разнесли в две колонки

Подробнее все написала на картинке:
​​Хелп Ситимобил

Посмотрим, как сделан хелп для пользователей такси Ситимобил. Я не буду рассматривать весь хелп, а только одну статью «Как заказать поездку?». Ссылки на нее нет, но я прикрепила внизу скриншоты. Еще вы можете сами найти все в приложении Ситимобил ( ☰—>Помощь—>Популярные вопросы—>Как заказать поездку?).

Логика и структура

Весь хелп построен как ответы на часто задаваемые вопросы. Один вопрос = одна статья. Но в статье «Как заказать поездку?» есть другие вопросы. Это делает статью длинной, статьи больше экрана неудобно читать на мобильном. Еще это ломает логику пользователя. На свой вопрос он ожидает увидеть один ответ, а не несколько новых вопросов. Поэтому лишние вопросы лучше вынести отдельно, а здесь добавить ссылку на них.
Так как в статье описаны действия, которые нужно выполнять последовательно, то нужен нумерованный список. Лучше него для таких случаев еще ничего не придумали.

Точность

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

Слова и фразы

В тексте есть:
- оценочные суждения (просто и легко);
- слова усилители (очень и обязательно);
- всякие пассивные штуки (вам откроется страница, стоимость поездки будет рассчитана);
- зоопарк терминов (поездка, такси, машина, заказ, автомобиль);
- канцелярит (адрес своего места нахождения и адрес места назначения, которые сложно не только правильно писать, но и выговорить);
- сложный термин (push-уведомления, потому что, если мы пишем для пользователя, который не смог заказать такси из приложения, то почему он должен знать про push-уведомления).
От этого нужно избавиться. Из зоопарка терминов оставим только такси (с глаголами будет: заказать такси и отменить такси).

Как можно сделать

Как заказать такси
1. Выберите, откуда вы хотите поехать. Для этого переместите синюю метку в нужное место на карте.
2. Введите конечный адрес в поле Куда.
3. Выберите способ оплаты. Для этого нажмите на кнопку 💳 Не выбрано.
4. Если нужно, добавьте дополнительные услуги, например, детское кресло или перевозку животных. Для этого нажмите на кнопку Пожелания. Некоторые услуги платные.
5. Нажмите кнопку Заказать такси.

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


Вопросы, которые у меня остались

Есть несколько моментов, которые я бы отразила в статье, но не знаю ответов.
- Что придет, если push-уведомления отключены у пользователя?
- Можно ли изменить способ оплаты после заказа такси?
- Как работает оплата по счетчику?

Почему нельзя все взять и удалить

Для тех, кому кажется, что все очевидно и такая статья в хелпе не нужна, у меня есть исследование от Nielsen Norman Group. Если коротко, компьютерные навыки пользователей хуже, чем вы думаете.

#примеризжизни #makedocumentationgreat #хелплинч
​​​Снова про кассу

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

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

Что понравилось:
- про оплату картой (это важная информация) написали в самом верху и крупно
- у каждого шага есть цифра и глагол
- картинки помогают, активные объекты подсвечены красным

#бытовуха #примеризжизни
​​Встроенные хелпы Miro и Whimsical

Я уже писала про то, что мне нравится хелп Miro. Но всегда есть что добавить.

Кроме основного хелпа у Miro есть встроенный хелп. Такой хелп удобен, потому что пользоваться им можно без поиска в гугл, дополнительных вкладок в браузере и СМС. То есть в любой непонятной ситуации пользователь может открыть хелп в интерфейсе и решить свою проблему. У Miro во встроенном хелпе в разделе How-to собраны подсказки по работе с интерфейсом: как выбрать несколько объектов и нарисовать стрелки. Каждая статья — это gif с пояснением.

Whimsical (коллеги Miro, тоже делают whiteboard для совместной работы) сделали встроенный хелп с помощью возможностей своего сервиса. То есть они собрали описание базовых возможностей сервиса на whiteboard. На whiteboard несколько gif с пояснениями (опять) и задания, которые пользователь может попробовать выполнить сам по инструкции, но без обязательств, проверок никаких нет.

#makedocumentationgreat #примеризжизни