307 пакетов: О документации, обязанностях и протухшей инициативности

Поговорили о том, зачем разработчикам документация, почему она не работает, и как заставить её работать нормально. Обсудили, как правильно вести записи и зачем передавать друг другу знания о проектах. Понудили о гайдах по документации и поискали самые рабочие.

У микрофона:

Сережа — любит писать документацию
Витя — любит смотреть как пишут документацию

В гостях:
Антон — компетентный гость из мира Android-разработки

Полезные ссылочки:

https://docusaurus.io/
https://documentation.divio.com
https://www.books.ru/books/97-etyudov-dlya-arkhitektorov-programmnykh-sistem-745663
https://knowledgeconf.ru/2022

****
Таймкоды:

00:21 Приветствие
00:57 Для чего нужна документация?
01:23 Почему не работает документация?
03:24 Документация в шапке в коде
04:12 Типы документации и кто её пишет
10:15 Виды документаций
11:35 RFC
14:49 Один из больших плюсов написания документации
15:49 Продолжаем про виды документации
18:25 Поддержка актуальности документации
27:10 Новость от коллеги
27:55 Поиск документации
43:00 Главные цели документации
44:06 Вывод по поиску документации
45:04 Подводим итоги
48:43 Кто должен писать документацию?
50:55 Форматы документации
55:28 Доводим итоги
55:14 Поки-поки

****

Шоу выходит при поддержке компании Space307:
https://space307.com

Послушать подкаст на других площадках:
https://podcast.space307.team

Видео 307 пакетов: О документации, обязанностях и протухшей инициативности канала Space307