Shut up and write

2020-12-18 15:00:38 ​​Инструкции совсем как у Икея

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

Я нашла онлайн-платформу Cadasio, с помощью которой можно создать из 3D моделей картинки или анимированные видео.

Как это работает:

1. Вы загружаете CAD-файл 3D модели в Cadasio.
2. Выбираете правильный ракурс. Можете отсоединить какую-то деталь из модели, добавить стрелочки или текст.
3. Когда все готово, делаете снимок. Чтобы сделать анимированное видео, нужно последовательно сделать снимки для нескольких шагов.

В итоге вы получите ссылку на изображение или QR-код. Потом можно отредактировать изображение в программе, но ссылка останется та же.

Программа бесплатная для личного использования. Есть похожие платные аналоги, например, Solidworks Composer и Catia Composer.

#tools Открыть/Комментировать

2020-12-04 15:01:01 Краткое содержание. Ноябрь

- Статья Дизайн имени. Почему мы меняем названия должностей нашей контент-команды.

Shopify переименовали контент-стратегов в контент-дизайнеров. Потому что новое название точнее описывает работу и результаты, хорошо согласуется с должностями дизайнеров, понятнее для людей не из дизайна.
Цитата: Этот простой ярлык не меняет того, как мы делаем эту работу, но он помогает другим понять наше место в ней. Вот что делают хорошие имена.
В посте за октябрь писала про такое же переименование в Facebook.

- Статья Насколько видео улучшает результаты обучения по сравнению с чтением?

В 2018 году MIT Integrated Learning Initiative (MITili) проверяла эксперимент. Участников разделили на 2 группы: одни смотрели видео-лекцию, другие читали текст лекции с диаграммами. Эффективность обучения померяли тестом на следующий день после обучения.
Выводы: эффективность обучения для видео и текста одинаковая. Влияние могло оказать то, что участники знали про проверку после обучения, поэтому были очень внимательны.
Другие факторы (недостаток сна или алкогольные напитки накануне вечером) не оказали статистически значимое влияние на обучение.

- Статья Voice and tone

Adobe разделяют тон и голос, тон меняется в зависимости от ситуации. Чтобы определить с правильным тоном, сделали тональный спектр и тональный гид. Тон и голос — часть дизайн системы.
Пост с примерами голосов других компаний.

- Статья Как дизайнер продукта и UX-писатель создают командную синергию


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

- Статья Как создать гайдлайн по контенту в продукте

Пример создания гайдлайна по контенту силами одного UX-писателя за 10 месяцев.
Шаг 1. Провели исследование (посмотрели, что у конкурентов, поговорили с пользователями и командой, провели аудит всего контента). После исследования появилось понимание, чего не хватает контенту, что он должен делать, какими должны быть голос и тон.
Шаг 2. Написали гайдлайн. Примерный план разделов: цели и принципы, аудитории, голос и тон, грамматика и пунктуация, термины, глоссарий, компоненты.
Шаг 3. Рассказали на общей встрече компании. Чтобы помочь командам понять и начать использовать гайдлайн, провели семинары.

#полезныессылки Открыть/Комментировать

2020-11-27 15:00:36 ​​Developer experience

В Slack Write the Docs запостили платформу для экспериментов над разработчиками — Haxor. Я eе не пробовала. Мне нравится идея и подход, что-то можно реализовать и без платформы.

Как это работает

1. Вы выбираете задание, которое разработчик должен выполнить с помощью вашего API/SDK. Желательно на час.
2. Платформа подбирает разработчиков.
3. Разработчики выполняют задание и попутно записывают видео.
4. Платформа логирует действия разработчиков: код, который они пишут, и приложения, которые они используют.
В итоге вы получаете отчет с метриками, видео и логами действий разработчиков. Процесс повторяется каждый месяц.

Метрики

В отчете 4 метрики:
- время на выполнение задания;
- % ошибок во время выполнения;
- % выполнивших задание;
- счастье .

И вот счастье — это самая интересная метрика. Она измеряется с помощью опросника, который когда-то придумали в IBM (Computer System Usability Questionnaire или PSSUQ). Разработчики оценивают насколько они согласны или не согласны с 16 утверждениями. Например такими:
- Пользоваться этой системой было просто.
- Было легко найти нужную мне информацию.
- Эта информация была эффективна, помогла мне выполнить задачу.
Получается, счастье разработчика — это когда есть понятная документация.

#экспериментыналюдях Открыть/Комментировать

2020-11-20 15:00:26 ​​Хелп Miro

Что мне нравится в хелпе Miro на примере статьи про инструмент Эмоджи. Я выбрала эту статью, потому что это рассказ об инструменте, a не пошаговая инструкция. Хороших пошаговых инструкций я видела много, хороших статей про инструменты — мало.

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

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

Текст

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

Гифки

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

Зачем тут хелп

У Miro удобный интерфейс, вы можете понажимать на разные кнопки и разобраться. При этом они поддерживают объемный хелп, в котором описано все. И это конкурентное преимущество. Потому что пользователей много, не все они готовы исследовать интерфейс.

#хелплинч #makedocumentationgreat Открыть/Комментировать

2020-11-06 14:00:21 Tools 2

Продолжаю публиковать инструменты, которые я когда-то нашла, но попробовала только сейчас. Часть 1 тут.

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

- Allwrite docs. Для тех, кто хочет сделать свою документацию из файлов Google Docs. Никакого языка разметки знать не надо, Allwrite docs сам конвертирует ваши файлы в html и markdown.
Бесплатно.

- PerfectIt. Плагин для Word. Находит опечатки и ошибки, проверяет пунктуацию в списках и таблицах, заглавные буквы и дефисы. Можно добавить свои правила.
Бесплатная пробная версия на 14 дней.

- Readme. Генератор для API документации. Редактирование в markdown, импорт из Swagger или OpenAPI Spec, управление версиями, есть готовые темы. В платной версии есть встроенная аналитика для API.
Есть бесплатная версия.

- Write good. Линтер, который может найти пассивный залог и слова, которые не несут смысловой нагрузки в документации, например, just, really, very, extremely. Только en.
Бесплатно.

- IBM Style guide. Линтер, который проверяет документ на соответствие IBM writing style guide. Только en.
Бесплатно.

Для переводов

- Weblate. Поддерживает много форматов перевода, к переводу можно добавить контекст (скриншот или описание), можно настроить проверки качества перевода.
Есть бесплатная версия.


Мне про него рассказал @crrlcx, вот его отзыв:
Близок по возможностям к Phrase, Strings, Localise и Crowdin, к тому же может использоваться не просто как внешний сервис, но и как собственный.
На Weblate остановились из-за 2 вещей — его можно запустить у себя и он базируется на фреймворке django, в котором у наших разработчиков есть достаточно компетенций, чтобы вносить исправления или создавать плагины и не ждать вендора.
Плюсом, который не был очевиден сначала, оказалась открытость Weblate, так что наши внутренние исправления можно было предложить проекту сразу на github в виде пуллреквеста.

#тулзы Открыть/Комментировать

2020-10-23 14:00:52 Adobe DITAWORLD 2020

Опубликованы доклады с конференции Adobe.

Для меня самыми интересными были:

- Beyond the OT. Sarah O’Keefe, CEO at Scriptorium
О том, можно ли из DITA OT получить что-то кроме стандартных PDF и HTML. Например, InDesign, PowerPoint или JSON.

- Customer Experiences – Powered by AI. Elliot Sedegah, Group Product Marketing Manager Adobe
Как можно упростить работу с контентом с помощью AI и что это изменит. Примеры: можно изменять контент под разные форматы и выделять основные слова из текста статьи и использовать их для тегов к статье.

- DITA, where art thou?. Kristen James Eberlein, OASIS DITA Technical Committee
Про жизненный путь архитектуры DITA и планы на будущее (DITA 2.0 и Lightweight DITA).

#вестникмитапов Открыть/Комментировать

2020-10-16 15:00:30 Red Hat Documentation

Red Hat собрали в одном репозитории стандарты и соглашения, связанные с документацией своих продуктов.

Что там есть:

- Инструмент newdoc, который создает файлы в формате AsciiDoc по шаблону Red Hat.
- Гайд по модульной документации. Red Hat строит документацию основываясь на user-stories (пользовательских сценариях). В гайде есть раздел с шаблонами.
- Гайды нескольких продуктов Red Hat. Тут можно прочитать и про файловую структуру документации этих проектов, и про настройку окружения для работы с документацией.
- Общий стайлгайд.

#гайд Открыть/Комментировать

2020-10-12 14:01:04 UPD Random Coffee

Я отправила всем участникам Random Coffee сообщения в телеграмм с именем их партнера. Дальше они сами знают, что делать
Новый раунд сделаю через две недели, оповещение будет на канале. Идеи можно писать в комменты или мне в личку. Открыть/Комментировать

2020-10-09 14:00:50 Краткое содержание

- Статья Почему мы переходим от контент-стратегии к контент-дизайну

В Facebook с 2009 года работают контент-стратеги, сейчас их 500 человек. Недавно они провели анализ рынка и поняли, что за это время термин «контент-стратегия» изменился. Сейчас контент-стратегия чаще всего относится к маркетингу. Поэтому команду контент-стратегии переименовали в команду контент-дизайна. Новое название лучше отражает задачи и роль.
Цитата: Мы действуем как контент-дизайнеры: люди, которые проектируют слова, концепции, системы и терминологию, голос и тон, и которые знают, насколько эти вещи важны для решения проблем людей, которые используют наши продукты по всему миру.

- Статья Размышление о тексте как о системе

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

- Пост в Телеграм
Наблюдение про зелёных менеджеров, которые готовы царапаться за свои формулировки

Бываю менеджеры, которые пишут тексты сами, а потом держатся за эти тексты и не дают их исправить. Тут проблема не в редакторе, не вините себя. Можно попробовать аргументировать свою позицию, объяснить работу редактора или давить через главреда.

- Презентация Как UX-писатели могут снизить когнитивную нагрузку

Когнитивная нагрузка — это время и умственные усилия, которые пользователь тратит, чтобы понять информацию. Чем меньше сил пользователь потратит на понимание, тем лучше. Чтобы снизить когнитивную нагрузку: 1) не используйте двойное отрицание 2) пишите числа цифрами 3) пишите текст только тогда, когда он нужен 4) используйте настоящее время и активный залог.

- Подкаст Начните UX-писательство в вашей компании

История о том, как стать UX-писателем. Как объединить дизайн-систему и стайлгайд. Про пользу от встреч для обсуждения проекта с дизайнерами (design+writer jam session). Как объяснить значимость UX-писателя в команде: протестировать тексты и опираться на это, рассказывать про свою работу, объяснять решения, давать почитать статьи.

#полезныессылки Открыть/Комментировать

2020-10-05 14:00:56 UPD Random Coffee

Неделя прошла, но у нас так и не хватает участников, чтобы использовать бота от Random Coffee. Альтернативного решения я пока не нашла. Поэтому пока генерить пары буду я:) Если вы хотите участвовать, напишите в что-нибудь в комментариях к посту. Открыть/Комментировать