Если меня спросят кем я хочу быть когда вырасту (как ТехПис), то я скажу, что хочу быть тем, кто пишет чейнджлоги к Slack. Эти ребята гении своего дела.

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

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

С самого перечня изменений можно похихикать где-то тут https://slack.com/release-notes/mac

#changelog #en

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

#changelog #ru

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

#changelog

Красивые чейнджлоги всегда в почете

#changelog

В далёком 2016 Airbnb поделились своей болью со скейлингом шаринга (простите) знаний и вариантами того, как это дело обуздать. В статье без откровений, но мне она нравится, подойдет как старт для тех, кто только задумался о построении системы по обмену знаниями внутри компании/команды.

И все эти годы они спокойно себе пилили свой 🚲. Судя по чейнджлогам - выглядит интересно. Делюсь, может кому подойдет.

Документация по этой системе живет тут

#knowledgemanagement #article #en #changelog #example

Кайфовый Твиттер-тред про то, как доносить (и как разные продукты/компании это делают) изменения в продукте до конечного пользователя. В треде собрано очень много и хороших и плохих примеров:

https://twitter.com/scottkubie/status/1064981319472553985?s=20

#changelog #en #article

Безумно люблю чейнджлоги, отчасти из-за них я и пошел в сторону техрайтинга и вообще полюбил разбираться в комплюктерах.

Я читаю абсолютно _все_ чейнджлоги _всех_ программ и приложений, что у меня установлены и очень грущу, когда разработчики не заботятся о том, чтобы менять дефолтные чейнджлоги и оставляют там примитивные “We made some improvements”.

Одни из первых (ну или из первых, кого заметили), кто сделал из чейнджлогов отдельный развлекательный жанр — Slack, и сегодняшняя статья как раз о них.

Отдельно хочу подметить, что это серия интервью, посвещенная как раз тем, кто пишет Release Notes, чейнджлоги и об остальных участниках процесса, которые помогают донести нововведения в продукте до конечного пользователя. Буду держать вас в курсе!

🔗 Читать: Slack’s empathy-driven approach to release notes, change management, and feature deprecations

#changelog #en #article

Люблю честные чейнджлоги ❤️

#changelog #en

Заметки о Release Notes

Релиз ноуты — неотъемлемая часть любого (опенсорсного, а по факту любого осознанного) проекта. Релиз ноуты не просто должны быть, но должны быть читабельными и полезными одновременно.

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

🔗 Читать: Writing better release notes

P.S

Мы уже не раз писали о релиз ноутах, дóроги они сердцу нашей редакции, так что предлагаю оглянуться назад:

1. The art of writing great release notes
2. Masters of Product Change: Taylor Singletary - Slack
3. Medium Release Notes: Historical record of the oft-overlooked communique known as the release note & Discord Changelogs

#changelog #en #article #resource

👅 Языки:

#ru | #en

👷 Карьера:

#career — советы и всемозможные статьи о карьере техписателя
#conference — техписательские конференции, их записи и заметки
#resources — ресурс для саморазвития
#article — полезная статья, которая учит чему-то клёвому, что позволит стать более лучшим писателем
#vacancy — интересная вакансия или что-то связанное с наймом
#video — видео, видос, видосичек, видосюлька. И подкасты!
#book — книга/хендбук
#courses — курсы, программы для технических писателей

🛠 Технологии:

#tool — полезная утилита/приложение
#changelog — все о чейнджлогах, примеры, правила
#markdown — все о языке разметки Markdown
#reStructuredText — все о языке разметки reStructuredText
#asciidoc — все о языке разметки asciidoc
#LaTeX — все систему набора и вёрстки и язык разметки LaTeX
#ide — среды разработки и все что с ними связано
#vscode — все о Visual Studio Code, настройка, плагины, хитрости
#SSG — JAMStack, генераторы статических сайтов, Hugo, Jekyll, Antora, etc.
#testthedocs — тестирование документации, линтинг
#API — про документирование API, примеры, лайфхаки, подсказки
#diagram — про диаграммы (много про diagrams as a code), mermaid, UML
#screenshot — все про скриншоты, утилиты, сервисы и красивенькие фотоснимки экрана
#ai — про GPT, GitHub Copilot и прочее, где ИИ помогает нам писать

🧺 Общее:

#tonevoice — о правилах общения в документации
#language — что-то конкретно о языке, в основном английский
#legal — юридическая документация, лицензии
#styleguide — все о стилях и правилах
#DocsAsCode — все про подход к документации как к коду
#example — примеры документации (хорошие и плохие)
#uiux — интерфейсы, текст в интерфейсах, пользовательский опыт
#knowledgemanagement — менеджмент знаний, хранилища, тулзы, техники, советы и наблюдения
#versioning — про версионирование
#accessibility — все об аксессебилити в документации
#checklist — чеклист/шпаргалка
#vintage — винтажная документация, старые компьютеры, софт, техника, игры
#visual — про визуальную составляющую документации
#metrics — все о метриках документации
#random — что-то совсем косвенно относящееся к техписательству, юморески

Предлагайте новые хэштеги в комментариях!