Внезапно MasterCard тоже делится (релевантными для нас) знаниями, ещё и контрибьютит в опенсорс.

В статье представлен небольшой кейс об автоматизации генерации диаграмм из текста (TL;DR: они пользуются моим любимым Mermaid).

Автор рассказывает зачем вообще нужны диаграммы в доках, кто их читает и почему выбрали именно mermaid

https://developer.mastercard.com/blog/automating-diagram-generation-from-text

#diagram #en #article #tool

Про иноды и хардлинки в 6 панелях комикса. Просто и доступно

#example #visual #en

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

#example #visual #en

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

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

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

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

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

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

Руководство по Читабельности от Content Design London — это:

- Ответы на 17 приоритетных вопросов по читабельности;
- Более 80 рекомендаций по читабельности: топовейший Readability Checklist;
- Всякое полезное по юзабилити-тестированию.

Из всего этого советую обратить внимание и взять на вооружение хотя бы некоторые пункты из чеклиста, дуже гарно!

#aceccibility #resource #article #en #styleguide

В последние пару недель приходится усиленно макать свои лапки в UX|UI писательство, а точнее — в онбординг в не самом простом приложении. Продавать буквами куда сложнее, чем объяснять что-то ими, поэтому всегда держите в уме вот эту простую весч:

https://www.useronboard.com/features-vs-benefits/

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

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

Конечно же я не имею в виду, что не нужно рисовать красивые иллюстрации и прописывать грамотно всякие feature-flow, просто делать это нужно держа в уме всё вышесказанное и строить онбординг-экспириенс отталкиваясь именно от этих простых, казалось бы, истин

#uiux #en #article #visual

Забыл сам, напомню теперь и вам, не используйте ie, eg и etc.

https://insidegovuk.blog.gov.uk/2016/07/20/changes-to-the-style-guide-no-more-eg-and-ie-etc/

#styleguide #en #resource

Гигантский монструозный лонгридище из 7 частей от "Богов Поиска" - Algolia. Рассказывают о том как они редизайнили свою документацию, от причин зачем это всё и UI/UX решений, вплоть до самого писательства и nitty-gritty технических моментиков.

1. Redesigning Our Docs – Part 1 – Why
2. Redesigning our Docs – Part 2 – Making Technical Content Readable for Everybody
3. Redesigning Our Docs – Part 3 – The UX/UI Phase
4. Redesigning Our Docs – Part 4 – Building a Scalable CSS Architecture
5. Redesigning Our Docs – Part 5 – Building an Interactive InstantSearch Showcase
6. Redesigning our Docs – Part 6 – The processes and logistics of a large scale project
7. Redesigning our Docs – Part 7 – What’s next to come

Бонусным треком статья от них же про API документацию с посылом и о том, что счастье не в тулзах с помощью которых это всё делается, а в деньгах, которые за это платятся, а в самом подходе к структурированию этой информации и в самом контенте. Иными словами тулинг должен заботить пусть и не в последнюю очередь, но и уж точно не в первую. Adapt the tool to the content, not vice versa.

Good API Documentation Is Not About Choosing the Right Tool

#API #en #article #resource #uiux

>Slack is actually an acronym. It stands for: "Searchable Log of All Conversation and Knowledge."

Делюсь бесплатной книжечкой с contentstrategy101 про Технический контент и преобразование оного в бизнес-велью-сущность

#resource #book #en

Скетч 2001го года с Норвежского телевидения, а актуально до сих пор и, к сожалению, будет актуально еще пару десятилетий 🤦‍♂️

Всех с праздничком и хороших выходных! ❤️