Podlodka #223 – Техническая документация

Техническая документация окружает нас повсюду – по нажатию подсказки в IDE, на GitHub-странице используемой библиотеки, в коробке с новенькой умной колонкой или стулом из IKEA. Какая-то документация помогает вам решить проблемы, а какая-то – только их создает. Андрей Поляков, тимлид команды технических писателей в Kotlin, рассказал все про то, как сделать документацию полезной.

Selectel — разверните IT-инфраструктуру проекта без изучения многостраничной документации: https://slc.tl/rJroW

12 июля стартует новый сезон Podlodka Frontend Crew. Подробности: https://podlodka.io/fecrew. Промокод для слушателей подкаста: PODLODKA_IS_NOT_A_FUNCTION

Вакансия в команду техписателей Kotlin: https://www.jetbrains.com/careers/jobs/technical-writer-397/

Поддержи лучший подкаст про IT:
www.patreon.com/podlodka

Также ждем вас, ваши лайки, репосты и комменты в мессенджерах и соцсетях!
Telegram-чат: https://t.me/podlodka
Telegram-канал: https://t.me/podlodkanews
Страница в Facebook: www.facebook.com/podlodkacast/
Twitter-аккаунт: https://twitter.com/PodlodkaPodcast

Ведущие в выпуске:
Стас Цыганов, Егор Толстой

Полезные ссылки:
- Google Technical Writing https://developers.google.com/tech-writing
- Microsoft Writing Styleguide https://docs.microsoft.com/en-us/style-guide/welcome/
- Node.js docs https://nodejs.org/en/docs/
- Qt docs https://doc.qt.io/
- .NET reference https://docs.microsoft.com/en-us/dotnet/api/?view=net-5.0
- LinkedIn Андрея https://www.linkedin.com/in/koshachy/