А
А общие разделы (повторяющиеся) доков подключаются к репозиториям проекта как субмодули
Size: a a a
2021 June 21
J
Андрей, а что вы имеете ввиду под дескрипшн, это редми или описание из комментариев кода?
А
описание из комментариев кода
J
Интересно👌, спасибо! А техпис как то принимает участие в правке комментариев кода или программисты пишут сразу хорошо и понятно?
RG
Типа doxygen?
А
программисты сразу и хорошо не умеют)) но техпис уже выступает просто редактором
J
Вот и я про это).
А
в смысле? все зависит от структуры софта. можно вытаскивать дескрипшн полей таблиц БД, объектов или как там реализовано. можно и xml парсить
J
Мне еще интересно, а как аналитиков включаете в разработку доков?
J
Я думал javadoc подключать
J
У нас аналитики ушли в сопротивление) ну не совсем, но не понимают зачем это все ибо visio и word проще.
А
есть бизнес-аналитики, которые формируют требования бизнеса. они рисуют BPM с описанием действий и шлюзов. все это парсится в доки постановки. затем подключается системный аналитик, который в теме системы и кода. он пишет ТЗ. затем контролирует мерджи изменения доков
А
из визио документа не построишь. а word - извечные проблемы стилей и форматирования
J
Да, мы поэтому и хотим уйти от этого, сдавали вордовские доки над которыми работало несколько человек, там со стилями получился полный треш, который я с большим трудом привел в порядок.
А
и не факт, что будет порядок, если заказчик или кто-то еще откроет документ в своем ворде))
А
ну а тут вам решать. каждый делает на тех инструментах, которые лучше знает и они удобны
J
Вот здесь у меня самая большая сложность, где лежат доки постановки, тз, руководства пользователей и админов для госконтракта и т.д.? Верней даже вопрос как это все структурировать?
J
И вернет потом со своими правками)
А
разложите древовидную структуру в порядке вложенности каталогов на гите (постановка, ТЗ, доки). можно использовать что угодно, хоть excel. затем все это в файловую структуру и коммит с мерджем в гит. кстати, сначала лучше структуру погонять в excel несколько дней. красота она такая... не сразу открывается))
А
и так по каждому проекту