Technical Writing 101 🇺🇦

В Quora запустили такую штуку как Spaces. Spaces - курируемые разделы посвященные какой-то определенной тематике и ессесно там есть раздел про техническое писательство, подписываемся.

https://www.quora.com/q/oubhsvimfatejoew?ch=10&share=34ed2914

#resource #en #article

Channel photo updated

Первая часть описывающая современный UX-райтинг тон в Microsoft. Как общаться с юзером и не звучать как робот:

https://medium.com/microsoft-design/microsoft-voice-principles-1-730f413190c1

#career #tonevoice #en #resource

Всё ещё частенько пользуетесь Google Docs по долгу службы, но упёрто хотите больше Markdown'а в своей жизни и жизни вашей компании? Получите и распишитесь, конвертер Docs в Markdown:

https://github.com/evbacher/gd2md-html/wiki

#tool #markdown #en

>Цель этого документа - предложить целенаправленную, четко определенную и ориентированную на читателя модель для сбора значимой и действенной обратной связи для улучшения качества документации и повышения удовлетворенности читателя.

https://www.stc.org/techcomm/2019/02/04/beyond-accuracy-what-documentation-quality-means-to-readers/

#testthedocs #resource #article #en

Как писать грамотные Error месседжи:

https://uxplanet.org/how-to-write-the-perfect-error-message-ffc132fda06a

#article #resource #en

Интересная подборка остроумных и смешных вырезок из *nix'овых man страничек

https://www.shellscript.sh/tips/man/

#vintage #example #en

Когда у вас спросят "Что такое плохая документация?" можете смело показывать им эту картинку.

#example #ru

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

https://m.habr.com/ru/company/yamoney/blog/439186/

Еще один крутецкий пример Comics as Documentation, в этот раз об устройстве сервисов Amazon:

https://www.awsgeek.com/

#visual #en

расписание докладов про документацию на FOSDEM https://fosdem.org/2019/schedule/track/tool_the_docs/, прямая трансляция https://fosdem.org/2019/schedule/streaming/

Дмитрий Макаров написал, чем UX-писатель отличается от копирайтера.

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

https://sobakapav.ru/articles/ux-writer-difference

Анастасия Степанова @anasta_ste поделилась своей статьей про ГОСТы по написанию документации:
https://docplace.ru/gost34/

#article #ru #resource

Yet Another Markdown Editor https://github.com/fabiospampinato/notable#readme

#tool #markdown #en

Тут выложили статистику (собранную с 71281 разработчика) с кучей всякой информации. Прошу обратить внимание на самую большую боль разработчиков — плохая документация.

https://research.hackerrank.com/developer-skills/2019

#article #en

Прекраснейшей информативности статья про Тултипы. Показывают c картинками Do's и Don't's, рассказывают в чем разница между Попап Типсами и Тултипсами и всякое такое!

https://www.nngroup.com/articles/tooltip-guidelines/


P.S Канал жив, а вот редакция едва ли. Гигантский загруз по работе, но я о вас не забыл, скоро разгребем всё и снова будем умнеть вместе

#visual #en #article

Для любителей порисовать диаграмки в Mermaid:
https://sprite.link/

#diagram #tool

Как я уже не раз говорил, доля Техписа может занести вас совсем не в туда, куда вы себе представляли, когда устраивались на оную должность. Так, например, вас могут напрячь быть каким-нить UI Writer'ом и писать интерфейсные тексты окажется не так просто, как выглядело со стороны. Сегодня мы попробуем не забыть о том, что иногда продукты переводят и интерфейсные тексты — тоже:

https://blog.prototypr.io/3-things-to-keep-in-mind-when-designing-ui-to-be-translated-in-different-languages-e1d02accf21c

#uiux #career #en

Не то, чтобы новость или что-то мега-примега полезное, но советую наблюдать за этой книгой, как выйдет — уверен, будет очень полезно и круто.
https://rosenfeldmedia.com/books/writing-for-interfaces/

#book #en #resource

Всем привет, опубликовали видеозаписи с Мини-Гипербатона, прошедшего в декабре:

- Методы оценки трудозатрат и сроков документирования (Александр Лебедев): https://events.yandex.ru/lib/talks/6821/
- Как измерить качество документации и эффективность её разработки (Светлана Каюшина, Юрий Никулин, Антон Литвинов): https://events.yandex.ru/lib/talks/6822/
- Кастомизация отчётов, или Как говорить на языке метрик без переводчика (Анастасия Агеева): https://events.yandex.ru/lib/talks/6825/