Technical Writing 101 🇺🇦
1.57K subscribers
244 photos
3 videos
12 files
418 links
Anything's A Documentation If You're Brave Enough

👋 @SuckMyNuts
Download Telegram
Forwarded from lil words make magic
Наташа, редактор в UX Яндекс.Денег, хорошо рассказывает про процессы здоровой команды, умение задавать вопросы и здравый смысл. А ещё о том, что придумать название кнопки — только маленькая часть работы редактора интерфейса.
Желаю всем таких процессов.

https://m.habr.com/ru/company/yamoney/blog/439186/
Когда у вас спросят "Что такое плохая документация?" можете смело показывать им эту картинку.

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

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

#vintage #example #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
Channel photo updated
В 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
Новых интересных статей не наблюдается, но вы держитесь. Тем временем нас почти 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
Google Docs в кой-то веки научился нативным якорным ссылочкам. Теперь никаких костылей в виде "закладок".

#tool #en
Маленький, но полезненький сайтец со всякими месседжами на все случаи жизни. Всё написано людским языком, ну как те самые лоадинг скрины в Slack, всё как вы любите. http://speakhuman.today

#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
Сегодня в эфире две полезные приложеньки

1) https://writefullapp.com - приложение/расширение для браузера (наверняка вы о нем уже слышали, but still), позволяет быстренько проверить словосочетание на популярность, сравнить две фразы друг с другом и всякое такое. Очень наглядно и частополезно, советую.

2) https://github.com/wkhtmltopdf/wkhtmltopdf - тулза которая "headless'ly" конвертит HTML в PDF (или картинку). Никаких зависимостей, чистый бинарничек, CLI, красота!