From b334f6d1d0bf5a2678f303b9e63aa50be0407d71 Mon Sep 17 00:00:00 2001 From: Ivan Smirnov <52702497+ivanmolodec@users.noreply.github.com> Date: Wed, 10 Jul 2024 11:03:21 +0300 Subject: [PATCH] Mermaid render (#15) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Добавлено описание mermaid --- README.md | 21 +++++++++++++++++++++ docs/L1SystemContext.md | 1 + 2 files changed, 22 insertions(+) diff --git a/README.md b/README.md index 3c6bb6c..8781b6e 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,27 @@ [Описание кода L4](docs/L4Code.md) +## Дополнительные инструменты визуализации диаграмм + +В случае описания небольшой системы/подсистемы можно использовать [Mermaid](https://mermaid.js.org/syntax/c4.html) - инструмент для визуализации диаграмм, ренедринг которого поддерживается напрямую в GitHub. Синтаксис похож на PUML с некоторыми отличиями и ограничениями. + +```mermaid +C4Context +title Example 1C C4 - System Context + +Person(SystemUser1, "Пользователь-исполнитель") +Person(SystemUser2, "Пользователь-руководитель") +System(System1C, "Система на платформе 1С") +System(OtherSystem1, "Внешняя система 1") +System(OtherSystem2, "Внешняя система 2") + +Rel(OtherSystem1, System1C, "Передача данных по НСИ", "AMQP") +Rel(System1C, OtherSystem2, "Передача остатков по складам", "HTTPS") +Rel_D(SystemUser2, System1C, "Смотрит отчеты") +Rel_U(SystemUser1, System1C, "Вводит данные") + +``` + ## Заимствования [1ce-icons-for-plantuml](https://github.com/ovcharenko-di/1ce-icons-for-plantuml) diff --git a/docs/L1SystemContext.md b/docs/L1SystemContext.md index e69de29..464e367 100644 --- a/docs/L1SystemContext.md +++ b/docs/L1SystemContext.md @@ -0,0 +1 @@ +# Слой L1 - System Context / System Landscape