Skip to content

Commit

Permalink
Обнавлен README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rpiontik committed Nov 26, 2022
1 parent 651642d commit 04e4d48
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 7 deletions.
13 changes: 12 additions & 1 deletion README.EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ Dochub supports:

* [PlantUML](https://plantuml.com/)
* [Markdown](https://ru.wikipedia.org/wiki/Markdown)
* [Mermaid](https://mermaid-js.github.io/mermaid/#/)
* [Swagger](https://swagger.io/)
* [AsyncAPI](https://www.asyncapi.com/)
* [Manifests](https://dochub.info/docs/dochub_contexts)


Expand All @@ -18,7 +20,8 @@ Dochub allows solves issues with:
* [Decentralized architecture management in Agile-oriented companies](#decentralized);
* [Ecosystem Architecture Management](#ecosystem);
* [Unified portal of documentations](#facade);
* [Consistency control](#problems).
* [Consistency control](#problems);
* [Extensible metamodel](extmetamodel)

### <a name="versioning"></a> Versioning Architecture

Expand Down Expand Up @@ -56,6 +59,14 @@ DocHub can find problems in the description of the architecture.

![problems](pics/problems.png)

## <a name="extmetamodel"></a> Extensible metamodel

МThe DocHub math model can be extended as you wish. It is possible to
both modify existing entities and create your own.

An example of creating the [C4 Model notation](https://github.com/rpiontik/DocHubExamples/tree/main/src/C4Model)


## Live demo portal

https://dochub.info/
Expand Down
29 changes: 23 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ DocHub - инструмент описания архитектуры через
решающих задачу описания. Поддерживаются:

* [PlantUML](https://plantuml.com/) - позволяет создавать диаграммы, используя простой и интуитивно понятный язык;
* [Mermaid](https://mermaid-js.github.io/mermaid/#/) - позволяет создавать диаграммы с использованием кода;
* [Markdown](https://ru.wikipedia.org/wiki/Markdown) - язык разметки, созданный с целью обозначения форматирования в тексте;
* [Swagger](https://swagger.io/) - язык описания HTTP API контрактов;
* [AsyncAPI](https://www.asyncapi.com/) - язык описания событийных контрактов;
* [Манифесты](https://dochub.info/docs/dochub_contexts) - структурированные файлы в формате YAML/JSON для описания архитектурных объектов.

Решаемые проблемы:
Expand All @@ -16,7 +18,11 @@ DocHub - инструмент описания архитектуры через
* [Децентрализованное управление архитектурой в Agile-ориентированных компаниях](#decentralized);
* [Управление архитектурой экосистемы](#ecosystem);
* [Создание архитектурных фасадов (портал документации)](#facade);
* [Контроль консистентности](#problems).
* [Контроль консистентности](#problems);
* [Расширяемая матамодель](#extmetamodel).

Для быстрого пользовательского старта рекомендую начать с прочтения статьи [Архитектра раядом с кодом](https://habr.com/ru/post/659595/)


[Живое демо и подробная документация](https://dochub.info/)

Expand All @@ -32,29 +38,38 @@ DocHub позволяет развивать кодовую базу архит
DocHub умеет консолидировать описание архитектуры из различных источников. Например, из разных репозиториев. Это
позволяет командам действовать независимо в сотрудничестве друг с другом.

![Инкрементальное развитие архитектуры](pics/decentralized.png)
![Децентрадлизованное управление архитектурой](pics/decentralized.png)

## <a name="ecosystem"></a> Управление архитектурой экосистем

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

![Инкрементальное развитие архитектуры](pics/ecosystem.png)
![Управление эксоситемой](pics/ecosystem.png)

## <a name="facade"></a> Архитектурные фасады

DocHub хорошо решает задачу публичного портала документации.

![Инкрементальное развитие архитектуры](pics/facade.png)
![Архитектурные фасады](pics/facade.png)

[Пример портала](https://dochub.info/).

## <a name="problems"></a> Контроль консистентности архитектуры

DocHub умеет находить проблемы в описании архитектуры.
DocHub умеет находить проблемы в описании архитектуры и контролировать определенные вами правила.

![Валидатор](pics/validators.png)

## <a name="extmetamodel"></a> Расширяемая матамодель

Матемодель DocHub может быть расширена по вашему желанию. Есть возможность как модифицировать
уже существующие сущности, так и создавать собственные.

Познакомиться с идеей ближе можно в статье [Код архитектуры — это жидкость](https://habr.com/ru/post/701050/).

![Инкрементальное развитие архитектуры](pics/problems.png)
Пример можно посмотреть [здесь](https://github.com/rpiontik/DocHubExamples/tree/main/src/C4Model)


## Развертывание
Expand Down Expand Up @@ -166,6 +181,8 @@ npm run build
# Статьи
* [Архитектура как кот VS Архитектура как кол](https://habr.com/ru/company/rabota/blog/578340/);
* [Архитектура как данные](https://habr.com/ru/post/593009/);
* [Архитектура рядом с кодом](https://habr.com/ru/post/659595/);
* [Код архитектуры — это жидкость](https://habr.com/ru/post/701050/);

# Лицензия
DocHub распространяется под лицензией Apache License 2.0 Open source license.
Binary file added pics/validators.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 04e4d48

Please sign in to comment.