Size: a a a

Technical Writing 101

2018 April 04
Technical Writing 101
Перепост нескольких статей с DOU которые довольно-таки внятно и пóлно поясняют, что из себя представляет должность Технического Писателя.

Статьи не мои, просто в таком формате удобнее их читать и кидать задающим вопросы, + тут они точно никуда не денутся, в отличие от DOU.

Если вы автор какой-то из этих статей и вас это напрягает — дайте знать.

1. Карьера в IT: должность Technical Writer
http://telegra.ph/Karera-v-IT-dolzhnost-Technical-Writer-04-04

2. Каково это — быть техрайтером
http://telegra.ph/Kakovo-ehto--byt-tehrajterom-04-04

3. Рекрутеру на заметку: собеседование с техрайтером
http://telegra.ph/Rekruteru-na-zametku-sobesedovanie-s-tehrajterom-04-04
источник
2018 April 05
Technical Writing 101
Если меня спросят кем я хочу быть когда вырасту (как ТехПис), то я скажу, что хочу быть тем, кто пишет чейнджлоги к Slack. Эти ребята гении своего дела.

Они даже описали свой подход к созданию самых милых, смешных но в то же время информативных чейнджлогов:

https://slackhq.com/a-little-thing-about-release-notes-997d2e06842d

С самого перечня изменений можно похихикать где-то тут https://slack.com/release-notes/mac
источник
2018 April 11
Technical Writing 101
Планирую рассказывать вам много мега крутых штук про Markdown, поэтому накатал небольшое вступление, что это такое и почему это прекрасно. Enjoy!

http://telegra.ph/Pogovorim-pro-Markdown-04-10
источник
2018 April 13
Technical Writing 101
В продолжение темы о прекрасных чейнджлогах.

Кроме Slack отличились и Medium, которые из каждого чейнджлога делают представление.
В самом последнем, например (см. картинку №1), стебутся над дачей показаний Цукербергом.
Тут вот даже некто завел отдельный блог на Медиуме, чтобы собирать их же чейнджлоги, for science! http://bit.ly/medium-changelog

Ну и, наверное, самые молодые и дерзкие — это Discord. Они позволяют себе легкие колкости (см. картинку №2)
и минимальный троллинг пользователей, при этом сохраняя профессионализм и свой фирменный стиль. Дискордом не пользуюсь, но иногда ловлю себя на мысли, что захожу просто так почитать их перечень изменений и поулыбаться. Похихикать можно тут http://bit.ly/discord-changelog

Если у кого-то есть еще отличные примеры смешных, интересных и всяких вот таких чейнджлогов - дайте знать в комментариях, люблю такое.
источник
Technical Writing 101
источник
Technical Writing 101
источник
2018 April 20
Technical Writing 101
Первая часть скромненького лонгрида про ultimate настройку текстового редактора для работы с Markdown и по превращению вас в более лучшего писателя. http://telegra.ph/Pimp-My-Markdown-Part-I-04-20-2
источник
Technical Writing 101
Вторая часть с открытыми комментариями http://telegra.ph/Pimp-My-Markdown-Part-II-04-20
источник
Technical Writing 101
Иногда по долгу службы сталкиваюсь с переводом договоров и не могу пройти мимо отличного образца. KPACUBO

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

https://creativecommons.org/licenses/by-sa/4.0/legalcode.ru
источник
2018 April 23
Technical Writing 101
Паша тоже котирует годные чейнджлоги :}
источник
Technical Writing 101
Меня тут в чате справедливо упрекнули, мол, постоянно постишь какой-то ад, но не показываешь нормальные примеры. Да на здоровье, смотрите:

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

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

Да, бесит – 26
👍👍👍👍👍👍👍 51%

Нет, не бесит – 25
👍👍👍👍👍👍👍 49%

👥 51 people voted so far.
источник
Technical Writing 101
Меня — бесит и Last.fm делает это с момента своего открытия
источник
Technical Writing 101
источник
Technical Writing 101
источник
2018 April 27
Technical Writing 101
Пока пишется следующая статейка —  наброшу ресурсов на почитать
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 — отличная и довольно активная группа в линкедине для вопросов да и просто почитать
источник
2018 May 04
Technical Writing 101
Кстать, там у Яндекса в Мае в Санкт-Петербурге проходит очередной Мини-Гипербатон (конференция для техрайтеров), а большой в сентябре. Будут рассказывать про редакторы для работы с текстами и всякую DITA-фигню, рекомендую к посещению ну или как минимум посмотреть видосы с конфы:
https://yandex.ru/blog/x-plain/mini-giperbaton-pro-redaktory-dlya-raboty-s-tekstami-anons-meropriyatiya
yandex.ru
Мини-Гипербатон про редакторы для работы с текстами. Анонс мероприятия
Всем привет, 24 мая в Москве и 25 в Санкт-Петербурге состоится Мини-Гипербатон, посвященный редакторам для работы с текстами.На встрече поговорим о средствах для широкого набора исходных форматов, а также средах для работы с DITA-контентом.Программу мероприятия и открытие регистрации для каждого города мы анонсируем дополнительно.Напоминаем, что Мини-Гипербатон — камерное мероприятие для обмена опытом на заданную тему с упором на живое общение, рассчитанное на небольшое количество участников. Для всех, кто не сможет присутствовать, мы выложим видеозаписи докладов.Также хотим поделиться, что большой Гипербатон в этом году состоится в сентябре: в июне и июле проводится чемпионат мира по футболу, что может создать сложности для посещении нашего мероприятия. Следите за новостями.
источник
Technical Writing 101
Если вы вдруг захотите слезть с Word’ов и прочих первобытых тулз и попытаетесь напрячь начальство на переход на работу с документацией как с кодом, то вот ключевые доводы которые будут полезны.
источник
Technical Writing 101
Нужно попрактиковаться в написании документации но нет под рукой друга-девелопера? Хочется пополнить портфолио, а ты все еще безработный и без опыта? Перечень опенсорсных проектов, которые с радостью примут вашу помощь:

https://www.reddit.com/r/technicalwriting/comments/800a9a/a_list_of_open_source_projects_with_volunteer/
источник
2018 May 07
Technical Writing 101
Хороший, нет прекрасный, или даже охуенный пример грамотной документации. Продавец доменов DNSimple на пальцах и как для детей поясняет как работает HTTPS и DNS
источник