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

👋 @SuckMyNuts
Download Telegram
Иногда по долгу службы сталкиваюсь с переводом договоров и не могу пройти мимо отличного образца. KPACUBO

Организация Creative Commons представила официальный перевод на русский язык набора лицензий Creative Commons 4.0, изначально выпущенного в 2013 году. Официальный перевод подготовлен после вступления в силу статьи 1286.1 Гражданского кодекса Российской Федерации, в которой введено понятие открытой лицензии на использование произведения науки, литературы или искусства. Перевод учитывает обозначенную в статье терминологию и оформлен в контексте определений открытых лицензий в российском законодательстве.

https://creativecommons.org/licenses/by-sa/4.0/legalcode.ru

#legal #ru
Паша тоже котирует годные чейнджлоги :}

#changelog #ru
Меня тут в чате справедливо упрекнули, мол, постоянно постишь какой-то ад, но не показываешь нормальные примеры. Да на здоровье, смотрите:

Как рассказывать об обновлениях — на примере Things

https://vk.com/@nepishiru-things-blog
Бесит ли вас когда какой-либо сервис обращается к вам на «ты»?
anonymous poll

Да, бесит – 30
👍👍👍👍👍👍👍 53%

Нет, не бесит – 27
👍👍👍👍👍👍 47%

👥 57 people voted so far.
Меня — бесит и Last.fm делает это с момента своего открытия
Пока пишется следующая статейка — наброшу ресурсов на почитать
1. http://www.writethedocs.org/
2. http://idratherbewriting.com/
3. https://clickhelp.co/clickhelp-technical-writing-blog/
4. https://techwhirl.com/ (так себе)
5. https://www.linkedin.com/groups/112571 — отличная и довольно активная группа в линкедине для вопросов да и просто почитать

#resources #en
Кстать, там у Яндекса в Мае в Санкт-Петербурге проходит очередной Мини-Гипербатон (конференция для техрайтеров), а большой в сентябре. Будут рассказывать про редакторы для работы с текстами и всякую DITA-фигню, рекомендую к посещению ну или как минимум посмотреть видосы с конфы:
https://yandex.ru/blog/x-plain/mini-giperbaton-pro-redaktory-dlya-raboty-s-tekstami-anons-meropriyatiya

#conference #ru
Если вы вдруг захотите слезть с Word’ов и прочих первобытых тулз и попытаетесь напрячь начальство на переход на работу с документацией как с кодом, то вот ключевые доводы которые будут полезны.

#DocsAsCode #en
Нужно попрактиковаться в написании документации но нет под рукой друга-девелопера? Хочется пополнить портфолио, а ты все еще безработный и без опыта? Перечень опенсорсных проектов, которые с радостью примут вашу помощь:

https://www.reddit.com/r/technicalwriting/comments/800a9a/a_list_of_open_source_projects_with_volunteer/

#resources #en
Хороший, нет прекрасный, или даже охуенный пример грамотной документации. Продавец доменов DNSimple на пальцах и как для детей поясняет как работает HTTPS и DNS

#example #en
В Твиттере узрел, что есть отдельный RFC (https://ru.wikipedia.org/wiki/RFC) на использование слова MUST, SHOULD, MAY в описании тех. продуктов https://tools.ietf.org/html/rfc2119

#example #en
Немного о грамотном подборе шрифтов для всяческой Complex Data (списки, аннотации и т.д) https://www.typography.com/blog/fonts-for-complex-data

#uiux #en
В ядрах всех крупных ОС обнаружена опасная уязвимость, которая позволяет получить доступ к памяти ядра или перехватить контроль над системой.

Уязвимости подвержены решения следующих производителей: Apple, DragonFly BSD Project, FreeBSD Project, ядро Linux, Microsoft, Red Hat, SUSE Linux, Ubuntu, VMware, Xen.

А причиной всему знаете что? Разработчики неправильно поняли инструкции в руководствах Intel и AMD.

That’s why грамотная документация может спасти мир!

Больше информации по ссылочке: https://www.kb.cert.org/vuls/id/631579

#examples #en
То же самое, но на русском —> http://www.opennet.ru/opennews/art.shtml?num=48569

#examples #ru
Там вышла новая версия Marked 2, ПРЕВЬЮВЕРА маркдауновской разметки. Пишете в Markdown в своем текстовом редакторе, а в соседнем окошке все красиво отрисовывается, экспортится, еще и темы красивые есть. К тому же, для текстовых джедаев, которые пользуются Scrivener — есть поддержка и его формата, что упрощает работу с гигантскими объемами текста. Чейгджлог тут http://marked2app.com/help/changelog.html, а качать вот тут http://marked2app.com/ (есть демо)

#markdown #en
Прозрачно и максимально доступно написанная (и переведенная к тому же на русский!) инструкция по Семантическому Версионированию от соучредителя GitHub https://semver.org/lang/ru/spec/v2.0.0.html

#versioning #en #ru
И один из >ЛУЧШИХ< мануалов которые я видел на эту тему. Красиво, практично, понятно даже младенцу. Стайлгайд по написанию самых-пресамых чейнджлогов. Берите на вооружение! https://keepachangelog.com/

#changelog