Forwarded from lil words make magic
Наташа, редактор в UX Яндекс.Денег, хорошо рассказывает про процессы здоровой команды, умение задавать вопросы и здравый смысл. А ещё о том, что придумать название кнопки — только маленькая часть работы редактора интерфейса.
Желаю всем таких процессов.
https://m.habr.com/ru/company/yamoney/blog/439186/
Желаю всем таких процессов.
https://m.habr.com/ru/company/yamoney/blog/439186/
Хабр
Редактор в UX: тру стори, риал лайф
Привет, это Наташа, лид-редактор в UX Яндекс.Денег. Я пишу этот текст, потому что больше не могу молчать о своей работе. Раньше про нас думали, что мы копирайтеры. Пишем получше, чем менеджеры....
Интересная подборка остроумных и смешных вырезок из *nix'овых man страничек
https://www.shellscript.sh/tips/man/
#vintage #example #en
https://www.shellscript.sh/tips/man/
#vintage #example #en
www.shellscript.sh
Witty 'man' page entries - From the Shell Scripting Tutorial Tips
Wit and humour in *nix documentation
Как писать грамотные Error месседжи:
https://uxplanet.org/how-to-write-the-perfect-error-message-ffc132fda06a
#article #resource #en
https://uxplanet.org/how-to-write-the-perfect-error-message-ffc132fda06a
#article #resource #en
Medium
How to write the perfect error message
Error messages are seemingly so innocuous but they’re actually incredibly important in ensuring good UX and keeping your end user happy. A…
>Цель этого документа - предложить целенаправленную, четко определенную и ориентированную на читателя модель для сбора значимой и действенной обратной связи для улучшения качества документации и повышения удовлетворенности читателя.
https://www.stc.org/techcomm/2019/02/04/beyond-accuracy-what-documentation-quality-means-to-readers/
#testthedocs #resource #article #en
https://www.stc.org/techcomm/2019/02/04/beyond-accuracy-what-documentation-quality-means-to-readers/
#testthedocs #resource #article #en
TechComm
Beyond Accuracy: What Documentation Quality Means to Readers
Yoel Strimling – The author proposes a focused, clearly defined, and reader-oriented model for collecting meaningful and actionable feedback to improve documentation quality and increase reader satisfaction. The model is based on results from a questionnaire…
Всё ещё частенько пользуетесь Google Docs по долгу службы, но упёрто хотите больше Markdown'а в своей жизни и жизни вашей компании? Получите и распишитесь, конвертер Docs в Markdown:
https://github.com/evbacher/gd2md-html/wiki
#tool #markdown #en
https://github.com/evbacher/gd2md-html/wiki
#tool #markdown #en
GitHub
Home
Convert a Google Doc to Markdown or HTML. This Docs add-on converts a Google Doc to simple Markdown and/or HTML. - evbacher/gd2md-html
Первая часть описывающая современный UX-райтинг тон в Microsoft. Как общаться с юзером и не звучать как робот:
https://medium.com/microsoft-design/microsoft-voice-principles-1-730f413190c1
#career #tonevoice #en #resource
https://medium.com/microsoft-design/microsoft-voice-principles-1-730f413190c1
#career #tonevoice #en #resource
Medium
The Microsoft Voice, Part 1: You Had Me at Human
How our UX writing principles keep us from sounding like robots
В Quora запустили такую штуку как Spaces. Spaces - курируемые разделы посвященные какой-то определенной тематике и ессесно там есть раздел про техническое писательство, подписываемся.
https://www.quora.com/q/oubhsvimfatejoew?ch=10&share=34ed2914
#resource #en #article
https://www.quora.com/q/oubhsvimfatejoew?ch=10&share=34ed2914
#resource #en #article
Предлагаю ознакомиться с качественным экземпляром "нарративной документации", господин-программист Scott B. Weingart рассказывает о приключении одного, но очень смелого SMS-сообщения, от начала его набора, до момента отображения его на экране у получателя.
http://scottbot.net/the-route-of-a-text-message/
Нарративное техническое повествование это к.р.у.т.о, прекрасно подойдет на почитать в теплый вечер среды.
#example #en
http://scottbot.net/the-route-of-a-text-message/
Нарративное техническое повествование это к.р.у.т.о, прекрасно подойдет на почитать в теплый вечер среды.
#example #en
>Компания Google анонсировала программу "Season of Docs", похожую на "Summer of Code", но нацеленную на подготовку документации для открытых проектов.
https://www.opennet.ru/opennews/art.shtml?num=50295
#example #career #en
https://www.opennet.ru/opennews/art.shtml?num=50295
#example #career #en
www.opennet.ru
Google представил инициативу по стимулированию написания документации для СПО
Компания Google анонсировала программу "Season of Docs", похожую на "Summer of Code", но нацеленную на подготовку документации для открытых проектов. Для участия в программе приглашаются технические писатели, которые совместно с кураторами из открытых проектов…
Сегодня небольшая подборочка проектов за которыми наблюдаю сам ну и вам советую, вдруг:
1. https://github.com/errata-ai/vale - один из самых мощных линтеров простого человеческого английского. Поддерживает крайне хитрые правила линтовки, если сильно заморочиться - может выйти свой стайлгайд, который через интеграцию в CI можно легко и без особых болей внедрить в команду\контору.
2. https://github.com/errata-ai/vale-server - CI это конечно хорошо, но блин, это сложно, интегрировать вот это куда-то, Тревисы и иже с ним. Не то! Так вот, запустился новый проектик по интегрированию Vale в сендбоксед приложения (aka Google Chrome (а значит и в ваш любимый Google Docs), Word и т.д). Hyped!
3. https://github.com/codercom/code-server - coder.com опенсорснули своё решение и теперь предоставляют Докер контейнер который запускается в пару кликов и позволяет запустить VSCode прямо во вкладочке браузера. Очень хочется себе такое, но пока не понял зачем.
#testthedocs #tools #en
1. https://github.com/errata-ai/vale - один из самых мощных линтеров простого человеческого английского. Поддерживает крайне хитрые правила линтовки, если сильно заморочиться - может выйти свой стайлгайд, который через интеграцию в CI можно легко и без особых болей внедрить в команду\контору.
2. https://github.com/errata-ai/vale-server - CI это конечно хорошо, но блин, это сложно, интегрировать вот это куда-то, Тревисы и иже с ним. Не то! Так вот, запустился новый проектик по интегрированию Vale в сендбоксед приложения (aka Google Chrome (а значит и в ваш любимый Google Docs), Word и т.д). Hyped!
3. https://github.com/codercom/code-server - coder.com опенсорснули своё решение и теперь предоставляют Докер контейнер который запускается в пару кликов и позволяет запустить VSCode прямо во вкладочке браузера. Очень хочется себе такое, но пока не понял зачем.
#testthedocs #tools #en
GitHub
GitHub - errata-ai/vale: :pencil: A markup-aware linter for prose built with speed and extensibility in mind.
:pencil: A markup-aware linter for prose built with speed and extensibility in mind. - errata-ai/vale
Ухты-ухты-ухты, тут вот New Your Times заопенсорсили своё документационное решение.
Деплоится на Хероку в один клик и живёт поверх ваших документов в Google Docs!
https://github.com/nytimes/library
#knowledgemanagement #tool #en
Деплоится на Хероку в один клик и живёт поверх ваших документов в Google Docs!
https://github.com/nytimes/library
#knowledgemanagement #tool #en
Маленький, но полезненький сайтец со всякими месседжами на все случаи жизни. Всё написано людским языком, ну как те самые лоадинг скрины в Slack, всё как вы любите. http://speakhuman.today
#tool #en
#tool #en
Что-то в последнее время то ли меньше времени на поиск и чтение всяких полезностей стало, то ли потеплело и пипл разленился писать.
Если вдруг у вас есть чем поделиться, чего еще небыло тут - милости прошу, кидайте всякое на @SuckMyNuts
Сегодня микростатейка про "дружбу, не вражду" UX и Тех. Документации
https://medium.com/gsoft-tech/docs-and-ux-its-a-collaboration-not-a-competition-b5076390c87a
А еще в новомодных GitHub'овских Actions появилась линтовка с помощью Vale, зацените, но оно оч сырое:
https://github.com/marketplace/actions/vale-lint
#uiux #testthedocs #tool
Если вдруг у вас есть чем поделиться, чего еще небыло тут - милости прошу, кидайте всякое на @SuckMyNuts
Сегодня микростатейка про "дружбу, не вражду" UX и Тех. Документации
https://medium.com/gsoft-tech/docs-and-ux-its-a-collaboration-not-a-competition-b5076390c87a
А еще в новомодных GitHub'овских Actions появилась линтовка с помощью Vale, зацените, но оно оч сырое:
https://github.com/marketplace/actions/vale-lint
#uiux #testthedocs #tool
Medium
Docs and UX: It’s a collaboration, not a competition
A look at how technical documentation and UX are stronger together
Сегодня в эфире две полезные приложеньки
1) https://writefullapp.com - приложение/расширение для браузера (наверняка вы о нем уже слышали, but still), позволяет быстренько проверить словосочетание на популярность, сравнить две фразы друг с другом и всякое такое. Очень наглядно и частополезно, советую.
2) https://github.com/wkhtmltopdf/wkhtmltopdf - тулза которая "headless'ly" конвертит HTML в PDF (или картинку). Никаких зависимостей, чистый бинарничек, CLI, красота!
1) https://writefullapp.com - приложение/расширение для браузера (наверняка вы о нем уже слышали, but still), позволяет быстренько проверить словосочетание на популярность, сравнить две фразы друг с другом и всякое такое. Очень наглядно и частополезно, советую.
2) https://github.com/wkhtmltopdf/wkhtmltopdf - тулза которая "headless'ly" конвертит HTML в PDF (или картинку). Никаких зависимостей, чистый бинарничек, CLI, красота!
Такой вам Daily Reminder о том, как определить Passive Voice
https://twitter.com/johnsonr/status/259012668298506240
https://twitter.com/johnsonr/status/259012668298506240
Twitter
Rebecca Johnson
I finally learned how to teach my guys to ID the passive voice. If you can insert "by zombies" after the verb, you have passive voice.