Мне очень хотелось найти чат-бота, который здоровается «ho-ho-ho merry christmas», но не вышло. Поэтому тут вам придется включить воображение😉

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

🍾Merry Christmas и с Новым годом!🎁

​Как тестирование бумажной инструкции привело к изменению части устройства

Отличная статья про тестирование продукта вместе с документацией.

Краткий пересказ
Делали сложную железку (подсветку для телевизора), которую пользователь должен был самостоятельно монтировать. Установить должна смочь любая домохозяйка. Решили протестировать на людях железку и две разные инструкции. В итоге переделали все.

Самый сок
* Проблема не всегда в документации, иногда нужно менять сам дизайн и техническое решение.
* Пример инструкции для чего-то нестандартного (я такое коллекционирую).
* Можно посмотреть процесс изменения инструкции.
* То, что люди на тестах не читали инструкцию до конца, еще не означает, что ее не нужно делать.

Послесловие
Меня осенило, что символ ✂️(ножницы с пунктиром) одна из первых символьных инструкций, как и 💾 (дискета). Так?

#экспериментыналюдях #намвсемнужнапомощь

Курсы по техническому писательству от Google📝

Наконец-то Google опубликовали свой курс по техническому писательству для разработчиков. Про его анонс я писала раньше.

В основном там про то, как писать из букв слова, а из слов предложения. Очень полезный навык. Для технических писателей, которые работают давно, все скорее всего известно. Но показать это своим коллегам-разработчикам стоит.

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


«Technical Writers provide a key link between Google engineers, product managers, marketing associates, developer advocates, as well as client developers and users, tying together many vital but disparate parts of the Google ecosystem.»

«Technical writers are rare hybrids, possessing an uncommon mixture of talents.» (
источник)

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

#makedocumentationgreat

Про деньги или где трава зеленее🌱

Я решила посчитать зарплаты технических писателей в Москве и Лондоне. Расчет основан на вакансиях из Linkedin, hh.ru, glassdoor и разговорах в кулуарах. Считала среднюю зарплату для среднего писателя (middle), потому что золотая середина:) На научность расчета не претендую.

Москва: 125 тыс. руб/месяц на руки.
Лондон: 55 тыс. фунтов/год до налогов, примерно 315 тыс. руб/месяц на руки. Примерно тут из-за изменений курса фунта и нефиксированного размера налога в UK.
Звучит в 2 раза больше. Но есть нюанс. Аренда, кафе и транспорт тоже стоят дороже.
Средняя зарплата в Лондоне 30 тыс. фунтов/год до налогов. В этой цифре посчитали всех подряд (посмотреть много статистики, про зарплаты в таблице 1.7a). У разработчиков тут средняя зарплата 70 тыс. фунтов/год, но налогов они платят больше🌱

Что нужно уметь техническим писателям в Лондоне, можно узнать в вакансиях на Linkedin. Для тех, кому лень гуглить: раз, два, три и еще одна вакансия.

🤖 Если готовы анонимно рассказать про свою зарплату, то ответьте вот тут на 4 вопроса.

#гдетравазеленее

Бесплатное обучение на карантине

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

1. Максим Ильяхов «Текст и деньги». Говорят, помогает повысить заработок, зани­ма­ясь текстом, редак­турой, дизай­ном или програм­мированием на заказ.
Затраты: 21 час.

2. Coursera «Writing Skills for Engineering Leaders» . Интересно, чему учат инженеров в этом курсе и есть ли отличия от курса Google.
Затраты: 17 часов.

3. Technical Writing: Documentation on Software Projects. Вводный курс про документацию ко всему и для всех, особых надежд не питаю, просто интересно.
Затраты: 4 часа.

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

#никогданепоздно

Что и как написать про COVID-19

Мир изменился неожиданно. Все перешли на удаленку, а основной темой стал COVID-19. В переписках привычное «Hi! Hope you are well» поменялось на «Hi! Hope you are well and stay at home». Spotify между мелодиями говорит «Stay home, help the NHS, save lives».

Какие-то сервисы уже написали про COVID–19. Например, Facebook и Pinterest просят оставаться дома. Asos и Amazon рассказывают про безопасность доставки. А навигатор Citymapper просит ограничить поездки.

Facebook о том, как заменить офлайн общение на онлайн через Facebook, а еще о борьбе со стрессом.

А это Pinterest просит мыть руки и дает ссылку на разные подборки картинок.

Asos на главной странице пишет, что стало больше времени на возврат и про безопасность доставки. В хелпе больше подробностей.

У Amazon очень небольшое упоминание COVID-19 интерфейсе. Подробности тоже в хелпе.

Citymapper передает рекомендацию от Транспортной компании Лондона.

Для тех, кому надо что-то написать COVID–19, есть clear language list (не знаю, как перевести) от контент дизайнера и стратега Лиззи Брюс (Lizzie Bruce).

Если видели еще хорошие примеры, то скидывайте в личку. Не болейте и stay home🏠

​​Как люди читают онлайн

Nielsen Norman Group опубликовали новую версию исследования о том, как люди читают в интернете. Прошлое исследование было 2006–2013 годах.

Не поменялось

Люди не читают слово за словом, а сканируют текст. Количество времени, которое человек готов потратить на текст, зависит от:
- Мотивации: насколько человеку нужна информация в тексте.
- Типа задачи: ищет человек конкретный факт или исследует тему.
- Уровня фокусирования: насколько человек сосредоточен на данной задаче.
- Личных качеств человека.

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

Новое

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

Обе эти модели встречаются, когда текст обтекает визуальные элементы. При этом визуальные элементы, которые прерывают текст, нарушают и чтение. Даже если человек до этого читал текст линейно и полностью, то после визуального элемента он останавливает чтение и переходит к сканированию. Картинка с примером ниже, чтобы не прерывать вам чтение:)

#экспериментыналюдях

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

#бытовуха

​​Запоздалые новости

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

​​Про Portal

А пока одни колонизируют Марс, я читаю документацию. Сегодня это документация к устройству для видеозвонков Portal. Чтобы его включить, нужно просто воткнуть вилку в розетку. Все очень просто, но в комплекте есть инструкция и в ней больше одного шага 😊

Зачем инструкция?

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

Еще раз про очевидные вещи

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

Третий шаг

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

Что дальше?

Но не все идеально, потому что в инструкции к устройству для видеозвонков нам не рассказали, как звонить. Наверное, потому, что дальше только ооочень простой интерфейс 😌
Конечно, это не вся инструкция, есть полная версия.

#намвсемнужнапомощь

Видеодокументация

На Хабре вышла статья про то, как технический писатель снимает видеоролики.

Ну, вышла и вышла, что в этом такого

Технический писатель делает весь ролик сам: сам пишет сценарий, снимает, записывает звук, монтирует. Тратит на ролик примерно 80 часов, а в статье рассказывает подробности процесса.
А процесс у них построен так, что работа над роликом не останавливается, даже если согласующие в отпуске, заболели, уехали в командировку. Чтобы не затянуть создание ролика, замечания вносят не все, а только самые критичные.
И конечно, очень классно, что на Хабре появляются статьи про документацию, про то какой она может быть разной и классной!🖤

Про сценарии

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

Идеальный мир

Несколько лет назад я считала, что видеоролики в документации — это трата времени и денег, а смотреть их никто не будет, ведь можно все прочитать. Сейчас мое мнение изменилось. На это повлияли разные исследования про восприятие информации, собственный опыт создания роликов и общение с теми, кто их смотрит.
Я все еще считаю, что видеоролики стоят дорого, а обновить их быстро не получится. Но если вы можете их сделать, то делайте. Мир меняется, теперь видео есть везде:
- Google
- Яндекс
- Ozon
- Miro

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

У видео есть недостатки, которые не дают ему полностью заменить текст. Про цену повторяться не буду🤑
Для меня основные это:
- Сложно что-то найти, Ctrl+F не работает, пробежаться глазами тоже не получится. Сейчас на Youtube можно добавить в видео встроенный таймлайн, это помогает, но все равно не поиск.
- Долго смотреть, прочитать можно быстрее. Особенно если вы хотите повторить (перечитать) какой-то момент.
- Нужен быстрый интернет, без ограничений по объему трафика. С этим могут быть проблемы, например, в путешествии.
- А еще нужно не забыть наушники.

#точкароста #самсебережиссер

​​Boйс и тон оф войс. Часть 1

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

Что такое голос и интонация?

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

Итого:
- Голос (voice) — постоянная величина, если вы решили, что вы разговариваете с пользователем по-человечески и не занудно, то громоздкие конструкции и сложные термины вы больше не используете.
- Интонация (tone of voice) — переменная величина, зависит от места и времени, но всегда соответствует вашему голосу. То есть вы можете шутить, а можете писать что-то серьезное, и все эти тексты не будут противоречить вашей интонации. Но громоздкие конструкции и сложные термины использовать нельзя все равно.
Достаточно сложно разделить голос и интонацию, это не всегда нужно и многие компании этого не делают.

Примеры голосов

Вот как описывают свои голос и интонацию разные компании:
- Mailchimp — откровенные, искренние, со сдержанным юмором.
- Monzo — разговаривают на языке своей аудитории, амбициозные, позитивные, открытые, инклюзивные.
- Atlassian — с твердой позицией, практичные, оптимистичные.
- Microsoft — теплые и спокойные, четкие и понятные, готовы протянуть руку помощи.
- Slack — уверенные в себе (но не дерзкие), остроумные (но не нелепые), в разговорном стиле (но всегда соответствующие и уважительные), интеллектуальные, дружелюбные (но не заискивающие), предупредительные (но не властные), ясные, лаконичные и человечные.
- Uber — внимательные, простые и постоянные, последовательные, а еще оптимистичные, гостеприимные.
- Skype — прямолинейные и человечные, с юмором.
- Bank of America — позитивные и оптимистичные, естественные и искренние, прямые и откровенные.

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

Викторина

Попробуйте угадать, какая из этих компаний могла написать такой текст:
A. Nоw that you've crеated the app dеscriptor, let's creаte the user interfаce using a simple static HTML page. This is the most bаsic type of XXX аpp, consisting only of аn аpp descriptor and an HTML page.
B. Fill оut yоur App Name and selеct the Develоpment Wоrkspace where you'll play around and build your app. Don't fuss too much over either field—no matter what worksрace you select, you'll still be able to distribute your app to other worksрaces if you сhoose.
C. Тар the Ноmе icon in the mеnu bаr, thеn scrоll to thе Pоt yоu wаnt tо clоsе
Тар thе Еdit button, then tap Dеlеtе Pоt in thе tор right оf thе scrееn
D. Sеarch bеcause it’s faster than scrоlling.

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

#тонофвойс

Nоw that you've crеated the app dеscriptor, let's creаte the user interfаce using a simple static HTML page. This is the most bаsic type of XXX аpp, consisting only of аn аpp descriptor and an HTML page.
anonymous poll

Microsoft – 8
👍👍👍👍👍👍👍 53%

Atlassian – 6
👍👍👍👍👍 40%

Slack – 1
👍 7%

Skype
▫️ 0%

👥 15 people voted so far. Poll closed.

Fill оut yоur App Name and selеct the Develоpment Wоrkspace where you'll play around and build your app. Don't fuss too much over either field—no matter what worksрace you select,you'll still be able to distribute your app to other worksрaces if you сhoose
anonymous poll

Slack – 7
👍👍👍👍👍👍👍 47%

Mailchimp – 7
👍👍👍👍👍👍👍 47%

Microsoft – 1
👍 7%

Uber
▫️ 0%

👥 15 people voted so far. Poll closed.