Архив рубрики ‘документирование’

Размышления о документации

Вряд ли найдётся кто-либо, кто в здравом уме и ясной памяти будет отрицать необходимость документации. Любой продукт имеет (или должен иметь) свою документацию. Как минимум – инструкцию о том, как этим продуктом пользоваться. Производители почти всегда указывают – «прежде чем начать пользоваться нашим продуктом, внимательно ознакомьтесь с инструкцией».  

Разработка требований к ПО с помощью Markdown, Git и Obsidian

Привет из ада трассировки требований В предыдущей статье автор сформулировал набор принципов организации хранения и оформления документации ПО, позволяющих преодолеть пропасть между требованиями верхнего уровня (ТВУ) бизнеса к программному продукту и требованиями нижнего уровня (ТНУ) к программному коду, а именно: Каждое требование записывается в отдельный файл в формате Markdown.

От Docs as Code к Everything as Code: как Gramax меняет работу с документацией

Привет, Хабр! Меня зовут Катя, я лидирую Gramax, open-source платформу для управления технической документацией. Однажды мы с коллегами утонули в хаосе рабочих документов: без версий, без согласований, без истории принятых решений. Это подтолкнуло нас к созданию Gramax — инструмента, который интегрирует документацию в процесс разработки, делая его прозрачным и управляемым. В этой статье расскажем, как […]

Эксплуатационные риски и их минимизация

Преамбула Всем знакома ситуация, когда на весь зоопарк из компьютеров, ноутбуков, планшетов, копировальной техники, серверов, активного сетевого оборудования и т.д. всего один админ. Он альтруист, вы не подумайте. Он любит свою работу. Он разбирается в теме. Он эффективен и глаза горят. Но как ни крути, когда вся ИТ функция предприятия, пусть даже небольшого, завязана на […]