Shut up and write
715 subscribers
42 photos
2 files
139 links
Я Маша и я технический писатель. Очень люблю документацию, особенно хорошую. Читаю все подряд: инструкции к стиральным машинам, правила пользования метро и справки разных сервисов.
На канале пишу о том, что понравилось или не понравилось.
@the_real_mari
Download Telegram
Предупреждение про короткий рабочий день перед Рождеством
* Или еще что-то очень важное. Навигатор Citymapper рассказывает, как будет работать общественный транспорт в Лондоне на Рождество (очень важное, потому что никак). Заодно они дают мини-хелп, как посмотреть маршрут на определенное время с учетом всех изменений в движении транспорта. На самом деле у них в тексте прекрасно все, даже эмоджи🙄 Смотрите сами.
А это попап в их приложении, чтобы вы точно ничего не пропустили
* Просто приятные мелочи. Новогоднее настроение повсюду, даже у приложения погоды. C высокой вероятность обещают Рождество.
Пасхалка про Рождество (пример из группы UX-писателей в Facebook)
Мне очень хотелось найти чат-бота, который здоровается «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 запустили-таки ракету. Но как можно было сомневаться в тех, у кого посадочная площадка называется «Просто прочти инструкции».