Комментарии 4
А мой склад тут при чем? У вас там все документы на java генерятся, и никаких визуальных редакторов нет, вечно их настройка заставляет страдать.
В контексте статьи - МойСклад это компания, которая разрабатывает одноимённый сервис, а документация это не справочный центр для пользователей, а статьи для внутреннего пользователя. Практика описания собственных систем - от стартапов с простой функциональностью до сложных ERP решений - распространена в различных компаниях, в том числе и у нас. Пишут её в основном люди для людей, потому что различные решения автоматизации не могут описать в человекочитаемом формате назначения функций целостной системы, бизнес кейсов, порядок тестирования и многие другие аспекты процесса разработки.
Можете подробнее раскрыть мысль о том, как у нас генерируются документы на Java и какие визуальные редакторы вы считаете необходимым использовать?
Интересно, особенно про диаграммы. Они отображаются в Gitlab? Используется ли для их визуализации какой-то отдельный инструмент?
В настройках GitLab можно включить отображение диаграмм PlantUML и указать адрес сервера, который используется для отрисовки - это может быть публичный сервер или собственный. То есть участнику работы с документацией достаточно указать в статье корректный код диаграммы и он отобразится в UI хостинга в виде готового изображения
Быть или не быть: анализ возможности применения подхода Docs-as-Code в МоемСкладе