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

#tool #markdown #en

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

#article #ru #resource

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

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

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

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

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

https://www.awsgeek.com/

#visual #en

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

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

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

#example #ru

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

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

#vintage #example #en

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

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

#article #resource #en

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

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

#testthedocs #resource #article #en

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

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

#tool #markdown #en

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

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

#career #tonevoice #en #resource

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

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

>Компания Google анонсировала программу "Season of Docs", похожую на "Summer of Code", но нацеленную на подготовку документации для открытых проектов.

https://www.opennet.ru/opennews/art.shtml?num=50295

#example #career #en

Новых интересных статей не наблюдается, но вы держитесь. Тем временем нас почти 400 (!)

#visual #en

Сегодня в Google Docs прилетела проверка Spelling and grammar, выглядит вот так. Круто, чё!

#tool #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

Ухты-ухты-ухты, тут вот New Your Times заопенсорсили своё документационное решение.
Деплоится на Хероку в один клик и живёт поверх ваших документов в Google Docs!

https://github.com/nytimes/library

#knowledgemanagement #tool #en