Skip to content

Commit

Permalink
Mermaid render (#15)
Browse files Browse the repository at this point in the history
* Добавлено описание mermaid
  • Loading branch information
ivanmolodec authored Jul 10, 2024
1 parent 1d14ee5 commit b334f6d
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
1 change: 1 addition & 0 deletions docs/L1SystemContext.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Слой L1 - System Context / System Landscape

0 comments on commit b334f6d

Please sign in to comment.