Доброго вечера. Студенты меня часто спрашивают про ведение документации, как правильно, где вести и т.д. Когда я начинал вариантов кроме ворда было не много, появлялись вики странички, но это было чревато работой с вики-разметкой, что далеко не всем подходило.
Потом появились модные конфлюенс и чуть менее модные ноушн и кода, в них доку стало вести удобнее, хотя по факту - это оптимизированные вики движки. Каждый со своими плюшками и минусами.
Я сам пока дорос только до этого уровня.
Хотя есть ребята, которые внедряют в свою работу практику Docs as Code, основанную на git и системе разметки, например, markdown. Вот пример реального использования. https://telegra.ph/Docs-as-code-DevOps-tehnologii-v-dokumentirovanii-ili-Kak-podruzhit-tehnicheskogo-pisatelya-i-razrabotchika-11-15
Да, статья, конечно пишет, что после этого освобождается 70% времени техписов, но мне кажется, что тут в первую очередь дело в синхронизации с разработчиками. Это не просто какой то писатель, а полноценный разработчик, со своей репой, коммитами и "кодом". Чувство причастности важная вещь.
Ну а в то, что это поможет драматически повысить скорость работы с докой - я не верю, если нет выстроенного процесса, то ни markdown ни notion не помогут.
Поделитесь в комментариях, кто чем пользуется и какие есть успехи?
#article