Документация и объяснения — недооцененная штука. Поэтому часто документация вещей вокруг нас бывает непонятна. А тут некие ребята написали про Теорию Документации в которой попытались объяснить, почему же документация часто не помогает: https://documentation.divio.com/ Согласно этой системе есть четыре разных типа документации. У них разная структура и цели. Туториалы Туториал — набор шагов для достижения какого-то первого значимого результата. Цель: помочь новичку сделать первый шаг, показать, что она/она может с помощью продукта добиться чего-то значимого и полезного...

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