Чтобы получить приглашение в Write The Docs Slack нужно ввести почту на http://slack.writethedocs.org/.

#en #resource

Вот такой вот юзер гайд в дополненной реальности https://twitter.com/mortenjust/status/1027183855692931072

#example #video #en

Объявили даты Шестого Гипербатона https://events.yandex.ru/events/hyperbaton/22-sep-2018/

#conference #ru

Все мы знаем про Семантическое Версионирование (RU) https://semver.org/lang/ru/ (EN) https://semver.org/, наткнулся тут на более лирическую, кхм, версию, сентиментальную и чувстввенную, так сказать. Sentimental Versioning http://sentimentalversioning.org/ — нарративная документация as is

#versioning #en

Пример лирического версионирования Ноды, аж в сердечке колет

#versioning #example #en

Еще немножко про версионирование, в этот раз предлагаю ознакомиться с календарной нумерацией релизов, ну как в Убунте https://calver.org/

#versioning #en

Чуть позже планирую выкатить пост про плохую документацию. Вот такие инструкции это прямо плевок в лицо всем, для кого это писалось. Пожалуйста, не делайте так.

#example #en

Markdeep (http://casual-effects.com/markdeep/) теперь поддерживает встраивание аудио и всяких там подкастов. Ух!

#markdown #tool #en

Решил поделиться парой полезных ссылочек, но вышел небольшой (достаточно большой для plaintext поста в Телегу) пост. Поэтому вот тут можно почитать один трюк, который поможет вам писать более простым языком, который сможет схавать больше людей, а ведь чем больше людей прочитает — тем вы полезнее для общества.

https://telegra.ph/O-prostote-08-29

#article #en

Docs Like Code запустили отдельную страничку с инструкциями по работе с Sphinx, Jekyll, Hugo, Continious Deployment док, Автотестам док и по работе с контентом в GH репах с, опять же, документацией:

https://www.docslikecode.com/learn/

P.S Поток контента чуть снизился из-за рабочего загруза, + понемногу пилю сайт-зеркало этого канала на котором будут статьи на английском ❤️

#DocsAsCode #SSG #en

Такой вам daily reminder об инвалидах:

Если вы технический писатель, значит наверняка вы любите помогать людям, но смею напомнить, что не все люди одинаково функционируют. Незрячим людям очень поможет ваш писательский талант. Пара советов по написаниют alt text к картинкам:

https://medium.com/@amyalexandraleak/should-you-use-alt-text-or-a-caption-48311e259ded


P.S Напоминаю, что в Markdown alt text задается в таком формате .

Всем здоровых глаз 👀

#accessibility #article #en

Списки — это хорошо и удобно, поэтому ловите пример хорошего, годного чеклиста для проверки качества документа, может вдохновитесь и в свой воркфлоу внедрите что-то аналогичное, если вы еще не.

#checklist #en

Немного оттопырю мизинчик и напомню вам о существовании Oxford Comma. Все иногда любят поспорить о её необходимости или об обратном, но мы то техрайтеры, в наших текстах не должна читаться двусмысленность, поэтому используем её примерно всегда, вот тут можно почитать/посмотреть чуть более длинный пост про это, enjoy:

https://medium.com/@kesiparker/how-to-use-the-oxford-comma-in-technical-writing-5d03bb39b966

#language #en

Совсем недавно у Write The Docs прошла конференция в Праге, если вы вдруг были не в теме или забыли или еще чего, то вот тут —> https://www.youtube.com/channel/UCr019846MitZUEhc6apDdcQ <— их канал на Ютубе, со всеми докладами за все предыдущеи годы и всякое такое.

Го умнеть вместе :3

P.S Особенно интересные доклады оттуда буду постить по мере просмотра.

#conference #en

Наткнулся тут на книжечку от ClickHelp о Техрайтинге.

Книга отлично подойдет тем, кто хочет вкатиться в специальность, покрывает такие темы как:
- В каких индустриях популярен техрайтинг?
- В чем на самом деле заключается работа техрайтера?
- Плюсы и минусы фриланса и работы в офисе.
- Что нужно знать, чтобы стать техрайтером?
- С какими трудностями сталкиваются техрайтеры в ежедневной работе.
- Всякие полезные утилиты.
- Как наладить рабочий процесс в док. команде.

#book #en

Техническое писательство иногда (исходя из моего опыта, окей если вы пишете исключительно мануалы и API-референсы, там этого практически нет) заводит в мир UX и написания текстов для “Call to Action’ов” т.н “Призывов к действию”. Копирую откуда-то определение с небольшими правками:

— Call To Action - это элемент, который подводит к логическому завершению сделки или предлагает перейти на следующий этап (какого-либо действия в пределах вашего проекта) —

Казалось бы, че там писать, одно-два слова в кнопочку, ан нет, ловите хорошие подсказки с примерами и советами как делать хорошо, а как нет:

https://medium.com/deliveroo-design/lets-do-this-how-to-write-better-calls-to-action-ea534768b599

#article #uiux #en

Сорри, что так редко выходит какой-то ориджынал контент, совсем нет времени, но вот вам (довольно небрежный, если уж совсем на чистоту, но суть ясна) мой перевод статьи Тома Престона-Вернера, со-основателя GitHub, о важности написания README в самом начале разработки (чего-либо).

https://telegra.ph/Readme-Driven-Development-09-25

#article #ru

Еще немного про инклюзивность (слепота, дислексия, новые пользователи продукта, не-нейтив спикеры) и вот это вот всё.

Гайд с подсказками как сделать жизнь вышеупомянутых групп меньшинств немножечко проще:

Оглавление:

— Как писать так, чтобы незрячие люди могли воспринимать вашу писанину с устойств для чтения с экрана;
— Как писать простым языком;
— Как подготовиться к переводу продукта;
— Как писать с оглядкой на ЦА;

#accessibility #en

Ну и чеклист по всем этим делам ;)

#checklist #accessibility #en