Shut up and write

Как Twilio создают документациюПересказ доклада Twilio про пределывание их документации. Полностью доклад можно посмотреть в одном из видео (раз и два, содержание на 80% совпадает) или почитать у них в блоге.ПредысторияКогда-то давно документация Twilio содержала много текста, который объяснял сложн...

Docs for DevelopersОбзор на книгу Docs for Developers: An Engineer’s Field Guide to Technical Writing, которая вышла в сентябре 2021. В посте есть спойлеры, если хотите сохранить интригу не читайте этот пост.Книга написана в соавторстве техническими писателями из Google, Microsoft, Stripe и Monzo.Ав...

Про редизайн документации GitLab - 2GitLab проводит ежегодные опросы пользователей, чтобы оценить качество своей документации. Результаты опроса этого года они опубликовали на Youtube. Про опрос прошлого года писала тут. Между опросами GitLab переделали левое меню навигации и сделали редизайн докуме...

2021 → 2022Краткое содержание 2021 и тренды на 2022.Что произошло за 2021 год- Gitlab, Canonical, Airbnb, Github, SAP писали про переработку своих сайтов документации и про то, как это важно.- согласно опросам SmartBear, Postman, Github, Google документация важна и нужна.- JetBrains разрабатывают ID...

​​Какой длины делать обучающие видео?Компания TechSmith, которая делает Snagit и Camtasia, опубликовала исследование про видео контент. С помощью исследования они пытались понять, почему люди начинают, останавливаются и продолжают смотреть обучающие и информационные видеоролики.- Исследование Video ...

The Best Developer Portals of 2021Объявили победителей премии The Best Developer Portals. Всего было номинировано 49 порталов. Про процесс оценки порталов жюри рассказали в интервью.Кто победилЛучший портал выбирали среди тех порталов, которые уже получили награду в других категориях. В итоге победи...

Краткое содержание. Ноябрь- Canonical (делают Ubuntu) опубликовали свои планы по преобразованию документации. За основу документации берут фреймворк Diátaxis. Считают, что документация очень важна. Планируют создать и поддерживать техническую документацию и практику документирования, которые будут п...

Эмоций разработчиков по отношению к документацииГруппа ученых из университета Indian Institute of Technology Tirupati провела эмоциональный анализ комментариев в коммитах, связанных с документацией. - Understanding Emotions of Developer Community Towards Software Documentation, 2021 год- Видео верси...

API Explorers or Try itПродолжу про API Explorer. Вот у каких компаний мне удалось его найти:- Facebook API Explorer. Доступен только после регистрации. Без регистрации можно посмотреть инструкцию к нему.- Asana API Explorer. И них у тоже есть инструкция к нему. - Google API Explorer и инструкция.- ...

API Explorer DocuSignAPI Explorer и API Request Builder — это части портала разработчика DocuSign.С их помощью можно:- протестировать API пока читаете документацию, не написав ни строчки кода- убедиться, что в документации все верно и ты все правильно понял- написать первый прототип быстрее, потому ...

Краткое содержание. Октябрь- Oпрос по зарплатам Write the Docs 2021. Принять участие можно до 20 декабря, результаты опубликуют в феврале 2022.- Голосование DevPortal Awards 2021. Проголосовать можно до 7 ноября.- Саммари API Specifications Conference 2021. В будущую спецификацию OpenAPI планируют в...

​​The F-wordЕсть распространенный способ собирать фидбек у читателей — добавить в документацию вопрос “Помогла ли вам эта статья” или “Была ли полезна статья”. Задавая такой вопрос, сложно получить фидбек, который можно использовать, потому что информации не хватает.В исследовании What Documentatio...