Andrey_Perelygin
@Andrey_Perelygin
CTO/Architect/Lead Developer

Какие вы знаете сервисы для создания структурной документации проекта?

Добрый день, хотел бы поинтересоваться какие интрументы проектирования и документирования архитектур сложных проектов вы знаете.

Общий кейс моих требований таков:
1. Визуальное отображение в виде блок схемы модулей проекта (мой проект пишется на основе микросервисной архитектуры, поэтому подобный подход подразумевает некую вложенность схем в друг друга) с возможностью текстового документирования любого из элементов
2. Встроенный таск менеджер или хорошая интеграция со сторонним сервисом, позволяющуя осуществлять линкование к таскам разработчиков какие элементы из упомянутой выше блок-схемы.
3. Текстовая документация API (знаю такой сервис для этого https://swagger.io/, мб возможна интеграция с ним)

Так как проект весьма большой и команда разработчиков с каждым днем становится все больше и больше, встает насущный вопрос о частичной автоматизации процессов построения и контроля roadmap разработки.

Из решений, с которыми мы приходилось работать могу озвучить связку draw.io+trello, но подобное решение не дает никакой структуры, либо табличные структуры.

Помимо вышеописанного вопроса, буду крайне рад получить советы по DevOps, которые актуальны для больших проектов или enterprise мира. В потенциале хотелось бы найти какую-то масштабируемую CRM систему, в рамках которой можно реализовать все вышеописанное, плюс хранилище ресурсов, git сервер, тестирование и еще кучу всего.

Спасибо.
  • Вопрос задан
  • 1074 просмотра
Пригласить эксперта
Ответы на вопрос 6
saboteur_kiev
@saboteur_kiev
build engineer
Да в общем-то при аккуратном подходе, обычный викидвижок подходит весьма удачно. Можно и confluence.
Слишком детализированная именно схема всего проекта нужна редко, в основном для красивой презентации.
А так - все разбивается на части, и влезает в обычные странички с ссылками.
Ответ написан
Я бы советовал посмотреть в сторону стэка atlassian. Jira как багтрекер и confluence для документации.
А Gitlab для хранения кода, CI/CD и прочего
Ответ написан
@kn0ckn0ck
Продюсер
А я бы посоветовал посмотреть в сторону бесплатного AgileTeam, в котором есть встроенная база знаний с возможностью документирования проекта с использованием UML. Там же есть встроенные Scrum и Kanban трекеры.
Ответ написан
AlexanderG
@AlexanderG
Я пользовался Visual Paradigm CE. Бесплатная, можно настроить, чтобы было красиво, поддерживаются практически любые мыслимые диаграммы.
Ответ написан
eduardtibet
@eduardtibet
Technical Writer / Documentation Engineer
Посмотрите презентации на этих страницах:

Потом - задайте уточнящие вопросы, если будут.
Ответ написан
@Mox
Team Lead, RoR, React/React Native
Я использую Dropbox paper, сложные вещи просто ембедятся в документ
Ответ написан
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через TM ID
Похожие вопросы