Документация проекта/проектов + связи

96
30 ноября 2020, 16:30

Есть несколько проектов, взаимодействующих друг с другом по http api или console api или еще как-нибудь.

Грубо говоря, проект состоит из приложений, приложения состоят из компонентов, компоненты состоят из интерфейсов и классов.

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

Подробно описывать методы классов нет необходимости, можно просто описать роль, цель, возможности. Или, может быть, только интерфейсы.

Какие есть инструменты для подобного документирования? Желательно с графиками отношений и более или менее удобным обновлением информации несколькими людьми, т.к. все постоянно дорабатывается.

На данный момент есть опыт работы с draw.io.

В принципе это все можно описать текстом + делать ссылки на draw.io, но может быть есть что-то еще.

UPD.

Примерно вижу это так:

  • Страница с диаграммой взаимодействия проектов (Что-то типа схемы базы данных)
  • Подобная страница с диаграммой взаимодействия компонентов внутри проекта
  • При переходе в проект видно описание и список компонентов и связанные проекты
  • При переходе в компонент видно описание, интерфейсы и связанные компоненты
READ ALSO
Размер watermark imagine

Размер watermark imagine

Мне на картинку необходимо вставить текстовый watermark использую следующий код:

98
Как определить создателя беседы через VK API?

Как определить создателя беседы через VK API?

В ВК с помощью метода messagesgetConversationMembers можно получить список участников беседы и их статус в беседе в виде JSON

137
Apache запретить доступ к файлам, Laravel

Apache запретить доступ к файлам, Laravel

Всем приветПо пути storage/5/sas24s15

96
Проблема кодировки строки

Проблема кодировки строки

Как превратить такую строку в читабельную?

104