2 года назад
Как писать документацию или какие существуют виды документаций?
Документация и объяснения — недооцененная штука. Поэтому часто документация вещей вокруг нас бывает непонятна. А тут некие ребята написали про Теорию Документации в которой попытались объяснить, почему же документация часто не помогает: https://documentation.divio.com/ Согласно этой системе есть четыре разных типа документации. У них разная структура и цели. Туториалы Туториал — набор шагов для достижения какого-то первого значимого результата. Цель: помочь новичку сделать первый шаг, показать, что она/она может с помощью продукта добиться чего-то значимого и полезного...
06:44
1,0×
00:00/06:44
42,7 тыс смотрели · 3 года назад
Почему важна SRE документация. Ч. 3
Перевод статьи подготовлен для студентов курса «DevOps практики и инструменты» в образовательном проекте OTUS. Документы для управления командами SRE Командам SRE для эффективной работы необходима надежная и доступная документация. Сайт команды Примечание: Вместо сайта можно использовать отдельный спейс или раздел в Confluence/Wiki. Сайт команды важен тем, что обеспечивает координацию информации и документации, связанной с командой SRE и ее проектами. Например в Google, многие команды SRE...