SpecialistOff.NET / Вопросы / Статьи / Фрагменты кода / Резюме / Метки / Помощь / Файлы

Назад

Документация

Метки:

Документация или театр начинается с вешалки

  1. Пет-проекты
    Хранение на своем личном ПК, в удобном для програмиста виде.
  2. Команда
    1. малочисленные и многочисленные команды
    2. удалённые или локальные команды
    3. проект монолитный или композитный, в т.ч. микросервисы
    4. авторитативное ведение документации (руководство, технические писатели) и демократический (с разделением прав)

Выбор системы для управления и хранения документации выбирается самостоятельно руководителем команды или коллегиальным решением. Для большинства проектов подойдет функционал вики-движка, но с точки зрения предъявляемых требований к системам ведения документации функционала может быть недостаточно. В корпоративных средах, в качестве системы ведения документации, широкое распространение получил Confluence. Описывать разницу между Confluence и вики мы конечно же не будем. Следует различать документацию разработчиков, системных администраторов и пользователей. Техническая документация может формироваться специальными средствами на основе комментариев непосредственно из кода.

Почему пишут свои самописные системы? Потому, что стандартного функционала какого-либо движка может не хватить. Например процесса принятия новой версии документа ответственными лицами, журналов, разделения на пространства, управления правами пользователей и групп пользователей, интеграций с сервисами.