@seafteam/seaf-archtool-core-plugin-suite 2026.29.0-rc-test.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/NOTICE +27 -0
- package/documentation/arch/aspects.yaml +81 -0
- package/documentation/arch/components/browser.yaml +51 -0
- package/documentation/arch/components/examples/context.yaml +37 -0
- package/documentation/arch/components/examples/order.yaml +92 -0
- package/documentation/arch/components/examples/payment.yaml +92 -0
- package/documentation/arch/components/examples/root.yaml +42 -0
- package/documentation/arch/components/front.yaml +309 -0
- package/documentation/arch/components/gitlab.yaml +81 -0
- package/documentation/arch/components/plantuml.yaml +57 -0
- package/documentation/arch/components/root.yaml +36 -0
- package/documentation/arch/components/user.yaml +41 -0
- package/documentation/arch/components/web.yaml +39 -0
- package/documentation/arch/contexts.yaml +99 -0
- package/documentation/arch/forms.yaml +36 -0
- package/documentation/arch/namespaces.yaml +43 -0
- package/documentation/arch/root.yaml +43 -0
- package/documentation/arch/rules.yaml +91 -0
- package/documentation/arch/technologies.yaml +84 -0
- package/documentation/dochub.yaml +32 -0
- package/documentation/docs/conception/archdistrib.puml +38 -0
- package/documentation/docs/conception/archeco.puml +11 -0
- package/documentation/docs/conception/archeco_proc.puml +29 -0
- package/documentation/docs/conception/archver.puml +24 -0
- package/documentation/docs/conception/facade.puml +20 -0
- package/documentation/docs/conception/introduction.md +144 -0
- package/documentation/docs/conception/mindmap.puml +55 -0
- package/documentation/docs/conception/root.yaml +66 -0
- package/documentation/docs/manual/aspects.md +37 -0
- package/documentation/docs/manual/backend/api.yaml +664 -0
- package/documentation/docs/manual/backend/search-implementation.md +190 -0
- package/documentation/docs/manual/backend/search.yaml +495 -0
- package/documentation/docs/manual/clickstream-setup.md +50 -0
- package/documentation/docs/manual/components.md +45 -0
- package/documentation/docs/manual/config/deployment.md +337 -0
- package/documentation/docs/manual/context_source.puml +17 -0
- package/documentation/docs/manual/contexts.md +200 -0
- package/documentation/docs/manual/datasets.md +120 -0
- package/documentation/docs/manual/docs/AI_TABLE_INTEGRATION.md +81 -0
- package/documentation/docs/manual/docs/asyncapi.md +63 -0
- package/documentation/docs/manual/docs/bpmn.md +122 -0
- package/documentation/docs/manual/docs/charts.md +371 -0
- package/documentation/docs/manual/docs/docs.md +76 -0
- package/documentation/docs/manual/docs/drawio_intro.md +397 -0
- package/documentation/docs/manual/docs/editable_table/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/root.yaml +9 -0
- package/documentation/docs/manual/docs/editable_table/step_0_base/menu.yaml +6 -0
- package/documentation/docs/manual/docs/editable_table/step_0_base/root.yaml +3 -0
- package/documentation/docs/manual/docs/editable_table/step_0_base/table.yaml +396 -0
- package/documentation/docs/manual/docs/editable_table/step_0_base/template.md +404 -0
- package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/root.yaml +3 -0
- package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/table.yaml +136 -0
- package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/template.md +247 -0
- package/documentation/docs/manual/docs/editable_table/step_2_parameterization/data/pets.yaml +23 -0
- package/documentation/docs/manual/docs/editable_table/step_2_parameterization/data/root.yaml +2 -0
- package/documentation/docs/manual/docs/editable_table/step_2_parameterization/menu.yaml +34 -0
- package/documentation/docs/manual/docs/editable_table/step_2_parameterization/root.yaml +4 -0
- package/documentation/docs/manual/docs/editable_table/step_2_parameterization/table.yaml +36 -0
- package/documentation/docs/manual/docs/editable_table/step_2_parameterization/template_root.md +110 -0
- package/documentation/docs/manual/docs/editable_table/step_2_parameterization/template_table.md +3 -0
- package/documentation/docs/manual/docs/editable_table/step_3_headers/menu.yaml +6 -0
- package/documentation/docs/manual/docs/editable_table/step_3_headers/root.yaml +2 -0
- package/documentation/docs/manual/docs/editable_table/step_3_headers/template.md +300 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/data/data.yaml +10 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/data/root.yaml +2 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/data/data_column_1.yaml +3 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/data/root.yaml +2 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/menu.yaml +6 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/root.yaml +4 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/table.yaml +52 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/template.md +117 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/root.yaml +2 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/menu.yaml +6 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/root.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/table.yaml +116 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/template.md +231 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/data.yaml +30 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/root.yaml +4 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/table.yaml +122 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/template.md +276 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/data.yaml +11 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/root.yaml +4 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/table.yaml +40 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/template.md +59 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/root.yaml +3 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/root.yaml +4 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/table.yaml +35 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/template.md +142 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/data.yaml +40 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/root.yaml +4 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/table.yaml +77 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/template.md +146 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/root.yaml +2 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/root.yaml +3 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/template.md +3 -0
- package/documentation/docs/manual/docs/editable_table/template.md +24 -0
- package/documentation/docs/manual/docs/examples/asyncapi.yaml +77 -0
- package/documentation/docs/manual/docs/examples/asyncapi_template.json +11 -0
- package/documentation/docs/manual/docs/examples/autors.yaml +30 -0
- package/documentation/docs/manual/docs/examples/bpmn.xml +44 -0
- package/documentation/docs/manual/docs/examples/cat.jpg +0 -0
- package/documentation/docs/manual/docs/examples/charts-bar.yaml +61 -0
- package/documentation/docs/manual/docs/examples/charts-bubble.yaml +47 -0
- package/documentation/docs/manual/docs/examples/charts-doughnut.yaml +42 -0
- package/documentation/docs/manual/docs/examples/charts-line.yaml +55 -0
- package/documentation/docs/manual/docs/examples/charts-pie.yaml +37 -0
- package/documentation/docs/manual/docs/examples/charts-polararea.yaml +54 -0
- package/documentation/docs/manual/docs/examples/charts-radar.yaml +50 -0
- package/documentation/docs/manual/docs/examples/charts-scatter.yaml +48 -0
- package/documentation/docs/manual/docs/examples/charts.yaml +91 -0
- package/documentation/docs/manual/docs/examples/contexts.jsonata +8 -0
- package/documentation/docs/manual/docs/examples/date-picker-example.md +5 -0
- package/documentation/docs/manual/docs/examples/example.html +2 -0
- package/documentation/docs/manual/docs/examples/example.puml +17 -0
- package/documentation/docs/manual/docs/examples/example.yaml +53 -0
- package/documentation/docs/manual/docs/examples/ext-schema.yaml +3 -0
- package/documentation/docs/manual/docs/examples/inlinemeta.md +25 -0
- package/documentation/docs/manual/docs/examples/markaper.yaml +225 -0
- package/documentation/docs/manual/docs/examples/mermaid.mmd +32 -0
- package/documentation/docs/manual/docs/examples/openapi_template.json +16 -0
- package/documentation/docs/manual/docs/examples/pizza-collaboration.xml +383 -0
- package/documentation/docs/manual/docs/examples/sa-anim.yaml +209 -0
- package/documentation/docs/manual/docs/examples/sa-complex-hide-boundary.yaml +94 -0
- package/documentation/docs/manual/docs/examples/sa-complex-hide-leaves.yaml +94 -0
- package/documentation/docs/manual/docs/examples/sa-complex-hide-title.yaml +98 -0
- package/documentation/docs/manual/docs/examples/sa-complex.yaml +92 -0
- package/documentation/docs/manual/docs/examples/sa-gravity.yaml +104 -0
- package/documentation/docs/manual/docs/examples/sa-group.yaml +93 -0
- package/documentation/docs/manual/docs/examples/sa-physical-connection.yaml +79 -0
- package/documentation/docs/manual/docs/examples/sa-query.jsonata +74 -0
- package/documentation/docs/manual/docs/examples/sa-symbol.yaml +72 -0
- package/documentation/docs/manual/docs/examples/sa-through-objects.yaml +46 -0
- package/documentation/docs/manual/docs/examples/sa-without-tips.yaml +43 -0
- package/documentation/docs/manual/docs/examples/showcases.jsonata +5 -0
- package/documentation/docs/manual/docs/examples/smartants_.yaml +160 -0
- package/documentation/docs/manual/docs/examples/table.yaml +341 -0
- package/documentation/docs/manual/docs/examples/template.puml +6 -0
- package/documentation/docs/manual/docs/examples/test.jsonata +3 -0
- package/documentation/docs/manual/docs/examples/toc/2header.md +8 -0
- package/documentation/docs/manual/docs/examples/toc/custom-toc-place-dup.md +37 -0
- package/documentation/docs/manual/docs/examples/toc/custom-toc-place.md +35 -0
- package/documentation/docs/manual/docs/examples/toc/root.yaml +38 -0
- package/documentation/docs/manual/docs/examples/toc/test.md +160 -0
- package/documentation/docs/manual/docs/gigachat/agents/aigena/menu.yaml +5 -0
- package/documentation/docs/manual/docs/gigachat/agents/aigena/root.yaml +2 -0
- package/documentation/docs/manual/docs/gigachat/agents/aigena/template.md +25 -0
- package/documentation/docs/manual/docs/gigachat/agents/menu.yaml +5 -0
- package/documentation/docs/manual/docs/gigachat/agents/react/gigachat.yaml +59 -0
- package/documentation/docs/manual/docs/gigachat/agents/react/menu.yaml +5 -0
- package/documentation/docs/manual/docs/gigachat/agents/react/root.yaml +3 -0
- package/documentation/docs/manual/docs/gigachat/agents/react/template.md +138 -0
- package/documentation/docs/manual/docs/gigachat/agents/root.yaml +5 -0
- package/documentation/docs/manual/docs/gigachat/agents/simple/gigachat.yaml +14 -0
- package/documentation/docs/manual/docs/gigachat/agents/simple/menu.yaml +5 -0
- package/documentation/docs/manual/docs/gigachat/agents/simple/root.yaml +3 -0
- package/documentation/docs/manual/docs/gigachat/agents/simple/template.md +113 -0
- package/documentation/docs/manual/docs/gigachat/agents/template.md +62 -0
- package/documentation/docs/manual/docs/gigachat/menu.yaml +5 -0
- package/documentation/docs/manual/docs/gigachat/root.yaml +4 -0
- package/documentation/docs/manual/docs/gigachat/settings/menu.yaml +5 -0
- package/documentation/docs/manual/docs/gigachat/settings/root.yaml +2 -0
- package/documentation/docs/manual/docs/gigachat/settings/template.md +51 -0
- package/documentation/docs/manual/docs/gigachat/template.md +38 -0
- package/documentation/docs/manual/docs/images/cloud.png +0 -0
- package/documentation/docs/manual/docs/images/component.png +0 -0
- package/documentation/docs/manual/docs/images/system.png +0 -0
- package/documentation/docs/manual/docs/images/user.png +0 -0
- package/documentation/docs/manual/docs/markaper.md +278 -0
- package/documentation/docs/manual/docs/markdown.md +148 -0
- package/documentation/docs/manual/docs/mermaid.md +43 -0
- package/documentation/docs/manual/docs/network.md +117 -0
- package/documentation/docs/manual/docs/plantuml.md +28 -0
- package/documentation/docs/manual/docs/root.yaml +736 -0
- package/documentation/docs/manual/docs/seaf2drawio/examples/basic.yaml +13 -0
- package/documentation/docs/manual/docs/seaf2drawio/examples/diff.yaml +123 -0
- package/documentation/docs/manual/docs/seaf2drawio/examples/example_seaf_data.yaml +1689 -0
- package/documentation/docs/manual/docs/seaf2drawio/examples/root.yaml +5 -0
- package/documentation/docs/manual/docs/seaf2drawio/examples/templates.yaml +55 -0
- package/documentation/docs/manual/docs/seaf2drawio/examples/transformation.yaml +19 -0
- package/documentation/docs/manual/docs/seaf2drawio/object_description.md +35 -0
- package/documentation/docs/manual/docs/seaf2drawio/root.yaml +12 -0
- package/documentation/docs/manual/docs/seaf2drawio/seaf2drawio.md +118 -0
- package/documentation/docs/manual/docs/smartants.md +583 -0
- package/documentation/docs/manual/docs/svg_inline.md +66 -0
- package/documentation/docs/manual/docs/swagger.md +52 -0
- package/documentation/docs/manual/docs/tables.md +264 -0
- package/documentation/docs/manual/docs/templates/example.drawio +43 -0
- package/documentation/docs/manual/docs/templates/test.svg +79 -0
- package/documentation/docs/manual/docs/templates.md +361 -0
- package/documentation/docs/manual/docs/toc.md +137 -0
- package/documentation/docs/manual/entities/bstages.md +43 -0
- package/documentation/docs/manual/entities/bundle.md +105 -0
- package/documentation/docs/manual/entities/entities.md +727 -0
- package/documentation/docs/manual/entities/images/id_errors.png +0 -0
- package/documentation/docs/manual/entities/images/landspace.jpeg +0 -0
- package/documentation/docs/manual/entities/images/menu-single.jpeg +0 -0
- package/documentation/docs/manual/entities/images/menu-tree.jpeg +0 -0
- package/documentation/docs/manual/entities/images/object_select.png +0 -0
- package/documentation/docs/manual/entities/images/problems.png +0 -0
- package/documentation/docs/manual/entities/images/select_inter.png +0 -0
- package/documentation/docs/manual/entities/images/stages.jpg +0 -0
- package/documentation/docs/manual/entities/images/suggests.png +0 -0
- package/documentation/docs/manual/entities/intro.md +73 -0
- package/documentation/docs/manual/entities/rules.md +35 -0
- package/documentation/docs/manual/functions/example.yaml +50 -0
- package/documentation/docs/manual/functions/functions.md +51 -0
- package/documentation/docs/manual/functions/root.yaml +39 -0
- package/documentation/docs/manual/images/jbps1.1.png +0 -0
- package/documentation/docs/manual/images/jbps1.png +0 -0
- package/documentation/docs/manual/images/jbps2.png +0 -0
- package/documentation/docs/manual/images/vsc1.png +0 -0
- package/documentation/docs/manual/imports.md +59 -0
- package/documentation/docs/manual/introduction.md +38 -0
- package/documentation/docs/manual/jsonata.md +268 -0
- package/documentation/docs/manual/plugin-settings.md +134 -0
- package/documentation/docs/manual/plugins/interface.md +226 -0
- package/documentation/docs/manual/plugins/introduction.md +256 -0
- package/documentation/docs/manual/plugins/root.yaml +51 -0
- package/documentation/docs/manual/role-model.md +80 -0
- package/documentation/docs/manual/root-cluster-import.md +82 -0
- package/documentation/docs/manual/root.yaml +199 -0
- package/documentation/docs/manual/rules/exceptions.md +20 -0
- package/documentation/docs/manual/rules/exreason.md +3 -0
- package/documentation/docs/manual/rules/root.yaml +58 -0
- package/documentation/docs/manual/rules/rules.md +8 -0
- package/documentation/docs/manual/rules/standard.md +3 -0
- package/documentation/docs/manual/rules/validators.md +109 -0
- package/documentation/docs/manual/technologies.md +49 -0
- package/documentation/docs/root.yaml +32 -0
- package/documentation/docs/sequence.puml +48 -0
- package/documentation/docs/welcome.md +3 -0
- package/documentation/entities/extentions/entity.yaml +136 -0
- package/documentation/entities/extentions/templates/people.md +4 -0
- package/documentation/entities/interactions/entity.yaml +412 -0
- package/documentation/entities/interactions/templates/blank.puml +18 -0
- package/documentation/entities/interactions/templates/bpmn.xml +59 -0
- package/documentation/entities/interactions/templates/tree.puml +11 -0
- package/documentation/entities/root.yaml +33 -0
- package/documentation/root.yaml +37 -0
- package/metamodel/dochub/entities/aspects/base.yaml +73 -0
- package/metamodel/dochub/entities/aspects/blank.yaml +65 -0
- package/metamodel/dochub/entities/aspects/components.yaml +52 -0
- package/metamodel/dochub/entities/aspects/contexts.yaml +57 -0
- package/metamodel/dochub/entities/aspects/docs.yaml +51 -0
- package/metamodel/dochub/entities/aspects/hierarchy.yaml +80 -0
- package/metamodel/dochub/entities/aspects/root.yaml +9 -0
- package/metamodel/dochub/entities/aspects/summary.yaml +64 -0
- package/metamodel/dochub/entities/aspects/templates/components.md +5 -0
- package/metamodel/dochub/entities/aspects/templates/hierarchy.puml +5 -0
- package/metamodel/dochub/entities/aspects/templates/summary.md +9 -0
- package/metamodel/dochub/entities/aspects/templates/tree.puml +5 -0
- package/metamodel/dochub/entities/aspects/tree.yaml +37 -0
- package/metamodel/dochub/entities/components/base.yaml +97 -0
- package/metamodel/dochub/entities/components/blank.yaml +64 -0
- package/metamodel/dochub/entities/components/contexts.yaml +55 -0
- package/metamodel/dochub/entities/components/docs.yaml +50 -0
- package/metamodel/dochub/entities/components/hierarchy.yaml +84 -0
- package/metamodel/dochub/entities/components/index.yaml +17 -0
- package/metamodel/dochub/entities/components/root.yaml +8 -0
- package/metamodel/dochub/entities/components/summary.yaml +58 -0
- package/metamodel/dochub/entities/components/symbol.yaml +113 -0
- package/metamodel/dochub/entities/components/templates/hierarchy.puml +5 -0
- package/metamodel/dochub/entities/components/templates/summary.md +8 -0
- package/metamodel/dochub/entities/components/templates/tree.puml +5 -0
- package/metamodel/dochub/entities/components/tree.yaml +38 -0
- package/metamodel/dochub/entities/contexts/base.yaml +197 -0
- package/metamodel/dochub/entities/contexts/plantuml.yaml +241 -0
- package/metamodel/dochub/entities/contexts/root.yaml +5 -0
- package/metamodel/dochub/entities/contexts/smartants.yaml +177 -0
- package/metamodel/dochub/entities/contexts/templates/template.puml +183 -0
- package/metamodel/dochub/entities/contexts/templates/tree.puml +5 -0
- package/metamodel/dochub/entities/contexts/tree.yaml +39 -0
- package/metamodel/dochub/entities/documents/base.yaml +73 -0
- package/metamodel/dochub/entities/documents/blank.yaml +28 -0
- package/metamodel/dochub/entities/documents/root.yaml +3 -0
- package/metamodel/dochub/entities/root.yaml +5 -0
- package/metamodel/dochub/functions/root.yaml +2 -0
- package/metamodel/dochub/functions/tools.yaml +46 -0
- package/metamodel/dochub/root.yaml +24 -0
- package/metamodel/dochub/rules/root.yaml +2 -0
- package/metamodel/dochub/rules/validators.yaml +144 -0
- package/metamodel/dochub/samples/01_components.yaml +23 -0
- package/metamodel/dochub/samples/02_contexts.yaml +23 -0
- package/metamodel/dochub/samples/03_documents.yaml +10 -0
- package/metamodel/dochub/samples/root.yaml +4 -0
- package/metamodel/dochub/samples/test.puml +17 -0
- package/metamodel/dochub.yaml +5 -0
- package/metamodel/docs/welcome.md +39 -0
- package/metamodel/root.yaml +8 -0
- package/package.json +29 -0
- package/plugin.html +1961 -0
|
@@ -0,0 +1,361 @@
|
|
|
1
|
+
# Шаблоны
|
|
2
|
+
|
|
3
|
+
Шаблоны предназначены для генерации документов на основании результатов [JSONata](https://jsonata.org/) запросов
|
|
4
|
+
с использованием [mustache](https://mustache.github.io/) языка.
|
|
5
|
+
|
|
6
|
+
## Markdown
|
|
7
|
+
|
|
8
|
+
Предоставляется возможность динамически создавать документы:
|
|
9
|
+
```yaml
|
|
10
|
+
docs:
|
|
11
|
+
...
|
|
12
|
+
archtol.templates: # Пример генерации документа по шаблону
|
|
13
|
+
location: SEAF.ArchTool/Руководство/Документы/Шаблоны
|
|
14
|
+
description: Markdown
|
|
15
|
+
type: markdown
|
|
16
|
+
autor: R.Piontik # Кастомное поле - Автор документа
|
|
17
|
+
approvers: # Кастомное поле - список согласующих
|
|
18
|
+
- P.Petrov
|
|
19
|
+
- S.Sidorov
|
|
20
|
+
- N.Nikolaev
|
|
21
|
+
source: > # JSONata запрос для формирования параметров шаблона
|
|
22
|
+
(
|
|
23
|
+
{
|
|
24
|
+
"id": $self._id, /* Идентификатор документа */
|
|
25
|
+
"autor": $self.autor, /* Автор документа */
|
|
26
|
+
"approvers": $self.approvers, /* Согласующие */
|
|
27
|
+
"docs": [docs.$spread().{ /* Другие документы автора */
|
|
28
|
+
"id": $keys()[0],
|
|
29
|
+
"title": *.description,
|
|
30
|
+
"autor": *.autor
|
|
31
|
+
}][autor=$self.autor]
|
|
32
|
+
}
|
|
33
|
+
)
|
|
34
|
+
subjects:
|
|
35
|
+
- dochub.front
|
|
36
|
+
- dochub.front.spa
|
|
37
|
+
- dochub.front.spa.blank
|
|
38
|
+
- dochub.front.spa.blank.doc
|
|
39
|
+
template: templates.md # Шаблон документа
|
|
40
|
+
...
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Код шаблона:
|
|
44
|
+
```mustache
|
|
45
|
+
{{=<% %>=}}
|
|
46
|
+
Результат:
|
|
47
|
+
* Идентификатор документа: **{{id}}**
|
|
48
|
+
* Автор: **{{autor}}**
|
|
49
|
+
* Согласующие: {{#approvers}}**{{.}}**; {{/approvers}}
|
|
50
|
+
* Другие документы автора:
|
|
51
|
+
{{#docs}}
|
|
52
|
+
* [{{title}}](/docs/{{id}})
|
|
53
|
+
{{/docs}}
|
|
54
|
+
<%={{ }}=%>
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Результат:
|
|
58
|
+
* Идентификатор документа: **{{id}}**
|
|
59
|
+
* Автор: **{{autor}}**
|
|
60
|
+
* Согласующие: {{#approvers}}**{{.}}**; {{/approvers}}
|
|
61
|
+
* Другие документы автора:
|
|
62
|
+
{{#docs}}
|
|
63
|
+
* [{{title}}](/docs/{{id}})
|
|
64
|
+
{{/docs}}
|
|
65
|
+
|
|
66
|
+
## PlantUML
|
|
67
|
+
|
|
68
|
+
Доступна генерация PlantUML документов:
|
|
69
|
+
```yaml
|
|
70
|
+
docs:
|
|
71
|
+
...
|
|
72
|
+
archtool.templates.pml: # Пример генерации PlantUML документа по шаблону
|
|
73
|
+
type: PlantUML
|
|
74
|
+
source: >
|
|
75
|
+
(
|
|
76
|
+
{
|
|
77
|
+
"entities": $distinct([ /* Получаем все использованные сущности при описании архитектуры */
|
|
78
|
+
components.*.entity
|
|
79
|
+
])
|
|
80
|
+
}
|
|
81
|
+
)
|
|
82
|
+
subjects:
|
|
83
|
+
- archtool.front
|
|
84
|
+
- archtool.front.spa
|
|
85
|
+
- archtool.front.spa.blank
|
|
86
|
+
- archtool.front.spa.blank.doc
|
|
87
|
+
template: examples/template.puml
|
|
88
|
+
...
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
Код шаблона:
|
|
92
|
+
```mustache
|
|
93
|
+
{{=<% %>=}}
|
|
94
|
+
@startuml
|
|
95
|
+
title Сущности использованные при описании архитектуры
|
|
96
|
+
{{#entities}}
|
|
97
|
+
{{{.}}} {{{.}}} as {{{.}}}
|
|
98
|
+
{{/entities}}
|
|
99
|
+
@enduml
|
|
100
|
+
<%={{ }}=%>
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
Результат:
|
|
104
|
+

|
|
105
|
+
|
|
106
|
+
## AsyncAPI
|
|
107
|
+
|
|
108
|
+
Важным приемуществом шаблонов, является возможность консолидации фрагментированных
|
|
109
|
+
артефактов в один. Например, можно в каждом отдельном компоненте описать контракты, а затем
|
|
110
|
+
собрать общий.
|
|
111
|
+
|
|
112
|
+
Манифест документа:
|
|
113
|
+
```yaml
|
|
114
|
+
docs:
|
|
115
|
+
...
|
|
116
|
+
archtool.templates.asyncapi: # Пример генерации AsyncAPI документа по шаблону
|
|
117
|
+
type: AsyncAPI
|
|
118
|
+
source: >
|
|
119
|
+
(
|
|
120
|
+
$BODY := $mergedeep([components.*.asyncapi]);
|
|
121
|
+
{
|
|
122
|
+
"content": [$BODY.$spread().{
|
|
123
|
+
"field": $keys()[0],
|
|
124
|
+
"body": $string($lookup($, $keys()[0]))
|
|
125
|
+
}]
|
|
126
|
+
}
|
|
127
|
+
)
|
|
128
|
+
template: examples/asyncapi_template.json
|
|
129
|
+
...
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
Шаблон:
|
|
133
|
+
```mustache
|
|
134
|
+
{{=<% %>=}}
|
|
135
|
+
{
|
|
136
|
+
"asyncapi": "2.4.0",
|
|
137
|
+
"info": {
|
|
138
|
+
"title": "Пример генерации асинхронных контрактов",
|
|
139
|
+
"version": "1.0.0",
|
|
140
|
+
"description": "Информация о контрактах собирается по всей архитектуре"
|
|
141
|
+
}
|
|
142
|
+
{{#content}}
|
|
143
|
+
,"{{field}}":{{&body}}
|
|
144
|
+
{{/content}}
|
|
145
|
+
}
|
|
146
|
+
<%={{ }}=%>
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
Манифест компонентов:
|
|
151
|
+
```yaml
|
|
152
|
+
components:
|
|
153
|
+
...
|
|
154
|
+
#***********************************************************
|
|
155
|
+
# Компонет-пример сервиса заказов
|
|
156
|
+
#***********************************************************
|
|
157
|
+
archtool.examples.orders:
|
|
158
|
+
title: Сервис управления заказами
|
|
159
|
+
entity: component
|
|
160
|
+
technologies:
|
|
161
|
+
- PHP
|
|
162
|
+
asyncapi: # Кастомное поле, созданное для примера сборки контрактов из архитектуры через шаблоны
|
|
163
|
+
servers:
|
|
164
|
+
orders:
|
|
165
|
+
url: mqtt://order.host.net
|
|
166
|
+
protocol: mqtt
|
|
167
|
+
description: Orders gateway
|
|
168
|
+
channels:
|
|
169
|
+
order/create:
|
|
170
|
+
subscribe:
|
|
171
|
+
operationId: emitOrderCreate
|
|
172
|
+
message:
|
|
173
|
+
$ref: "#/components/messages/OrderCreate"
|
|
174
|
+
components:
|
|
175
|
+
messages:
|
|
176
|
+
OrderCreate:
|
|
177
|
+
name: orderCreate
|
|
178
|
+
title: Создание заказа
|
|
179
|
+
contentType: application/json
|
|
180
|
+
payload:
|
|
181
|
+
$ref: "#/components/schemas/order"
|
|
182
|
+
schemas:
|
|
183
|
+
order:
|
|
184
|
+
type: object
|
|
185
|
+
properties:
|
|
186
|
+
id:
|
|
187
|
+
type: string
|
|
188
|
+
format: uuid
|
|
189
|
+
customer:
|
|
190
|
+
type: string
|
|
191
|
+
format: uuid
|
|
192
|
+
curr:
|
|
193
|
+
type: string
|
|
194
|
+
description: "Валюта"
|
|
195
|
+
value:
|
|
196
|
+
type: number
|
|
197
|
+
description: "Сумма"
|
|
198
|
+
createdAt:
|
|
199
|
+
type: string
|
|
200
|
+
format: date-time
|
|
201
|
+
description: "Момент создания"
|
|
202
|
+
#***********************************************************
|
|
203
|
+
# Компонет-пример сервиса оплаты
|
|
204
|
+
#***********************************************************
|
|
205
|
+
archtool.examples.payment:
|
|
206
|
+
title: Сервис оплаты
|
|
207
|
+
entity: component
|
|
208
|
+
expert: R.Piontik
|
|
209
|
+
technologies:
|
|
210
|
+
- SberPay
|
|
211
|
+
- Go
|
|
212
|
+
asyncapi: # Кастомное поле, созданное для примера сборки контрактов из архитектуры через шаблоны
|
|
213
|
+
servers:
|
|
214
|
+
payments:
|
|
215
|
+
url: mqtt://pay.host.net
|
|
216
|
+
protocol: mqtt
|
|
217
|
+
description: Payment gateway
|
|
218
|
+
channels:
|
|
219
|
+
pay/payment:
|
|
220
|
+
subscribe:
|
|
221
|
+
operationId: emitPayment
|
|
222
|
+
message:
|
|
223
|
+
$ref: "#/components/messages/Payment"
|
|
224
|
+
components:
|
|
225
|
+
messages:
|
|
226
|
+
Payment:
|
|
227
|
+
name: payment
|
|
228
|
+
title: Оплата
|
|
229
|
+
summary: Сообщение по оплате
|
|
230
|
+
contentType: application/json
|
|
231
|
+
payload:
|
|
232
|
+
$ref: "#/components/schemas/payment"
|
|
233
|
+
schemas:
|
|
234
|
+
payment:
|
|
235
|
+
type: object
|
|
236
|
+
properties:
|
|
237
|
+
account:
|
|
238
|
+
type: string
|
|
239
|
+
description: "Номер счета"
|
|
240
|
+
curr:
|
|
241
|
+
type: string
|
|
242
|
+
description: "Валюта"
|
|
243
|
+
value:
|
|
244
|
+
type: number
|
|
245
|
+
description: "Сумма"
|
|
246
|
+
createdAt:
|
|
247
|
+
type: string
|
|
248
|
+
format: date-time
|
|
249
|
+
description: "Момент создания"
|
|
250
|
+
...
|
|
251
|
+
```
|
|
252
|
+
|
|
253
|
+
Результат:
|
|
254
|
+

|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
## OpenAPI
|
|
258
|
+
|
|
259
|
+
Аналогично AsyncAPI можно собрать единый контракт для OpenAPI.
|
|
260
|
+
|
|
261
|
+
Манифест документа:
|
|
262
|
+
```yaml
|
|
263
|
+
docs:
|
|
264
|
+
...
|
|
265
|
+
archtool.templates.openapi: # Пример генерации OpenAPI документа по шаблону
|
|
266
|
+
type: OpenAPI
|
|
267
|
+
source: >
|
|
268
|
+
(
|
|
269
|
+
$BODY := $mergedeep([components.*.openapi]);
|
|
270
|
+
{
|
|
271
|
+
"content": [$BODY.$spread().{
|
|
272
|
+
"field": $keys()[0],
|
|
273
|
+
"body": $string($lookup($, $keys()[0]))
|
|
274
|
+
}]
|
|
275
|
+
}
|
|
276
|
+
)
|
|
277
|
+
template: examples/openapi_template.json
|
|
278
|
+
...
|
|
279
|
+
```
|
|
280
|
+
|
|
281
|
+
Шаблон:
|
|
282
|
+
```mustache
|
|
283
|
+
{{=<% %>=}}
|
|
284
|
+
{
|
|
285
|
+
"openapi": "3.0.0",
|
|
286
|
+
"info": {
|
|
287
|
+
"title": "Пример шаблона OpenAPI",
|
|
288
|
+
"description": "Контракты собираются из нескольких компонентов архитетуры"
|
|
289
|
+
},
|
|
290
|
+
"servers": [
|
|
291
|
+
{
|
|
292
|
+
"url": "http://host.net",
|
|
293
|
+
"description": "Сервис заказов"
|
|
294
|
+
}
|
|
295
|
+
]
|
|
296
|
+
{{#content}}
|
|
297
|
+
,"{{field}}":{{&body}}
|
|
298
|
+
{{/content}}
|
|
299
|
+
}
|
|
300
|
+
<%={{ }}=%>
|
|
301
|
+
```
|
|
302
|
+
|
|
303
|
+
Манифест компонентов:
|
|
304
|
+
```yaml
|
|
305
|
+
components:
|
|
306
|
+
..
|
|
307
|
+
#***********************************************************
|
|
308
|
+
# Компонет-пример сервиса заказов
|
|
309
|
+
#***********************************************************
|
|
310
|
+
archtool.examples.orders:
|
|
311
|
+
title: Сервис управления заказами
|
|
312
|
+
entity: component
|
|
313
|
+
technologies:
|
|
314
|
+
- PHP
|
|
315
|
+
...
|
|
316
|
+
openapi: # Кастомное поле, созданное для примера сборки контрактов из архитектуры через шаблоны
|
|
317
|
+
paths:
|
|
318
|
+
/orders:
|
|
319
|
+
get:
|
|
320
|
+
summary: Получение списка заказов
|
|
321
|
+
responses:
|
|
322
|
+
'200': # status code
|
|
323
|
+
content:
|
|
324
|
+
application/json:
|
|
325
|
+
schema:
|
|
326
|
+
type: array
|
|
327
|
+
items:
|
|
328
|
+
type: string
|
|
329
|
+
format: uid
|
|
330
|
+
#***********************************************************
|
|
331
|
+
# Компонет-пример сервиса оплаты
|
|
332
|
+
#***********************************************************
|
|
333
|
+
archtool.examples.payment:
|
|
334
|
+
title: Сервис оплаты
|
|
335
|
+
entity: component
|
|
336
|
+
expert: R.Piontik
|
|
337
|
+
technologies:
|
|
338
|
+
- SberPay
|
|
339
|
+
- Go
|
|
340
|
+
...
|
|
341
|
+
openapi: # Кастомное поле, созданное для примера сборки контрактов из архитектуры через шаблоны
|
|
342
|
+
paths:
|
|
343
|
+
/payments:
|
|
344
|
+
get:
|
|
345
|
+
summary: Получение списка счетов
|
|
346
|
+
responses:
|
|
347
|
+
'200': # status code
|
|
348
|
+
content:
|
|
349
|
+
application/json:
|
|
350
|
+
schema:
|
|
351
|
+
type: array
|
|
352
|
+
items:
|
|
353
|
+
type: string
|
|
354
|
+
format: uid
|
|
355
|
+
...
|
|
356
|
+
```
|
|
357
|
+
|
|
358
|
+
Результат:
|
|
359
|
+

|
|
360
|
+
|
|
361
|
+
|
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
|
|
2
|
+
# Отключение автооглавления в Markdown-документах
|
|
3
|
+
|
|
4
|
+
В Markdown добавлена возможность отключения автоматического оглавления (TOC), а также гибкого размещения его в тексте.
|
|
5
|
+
|
|
6
|
+
## Правила гибкого размещения TOC в тексте
|
|
7
|
+
- TOC должно вставляться в то место, где автор указал маркер **[[toc]]**.
|
|
8
|
+
- Если маркер указан — TOC рендерится только в этом месте.
|
|
9
|
+
- Если маркера нет, но TOC включено — вставляется в начало документа.
|
|
10
|
+
- Если маркера два в документе, то TOC вставляется только в первый.
|
|
11
|
+
- Если в YAML **toc: false**, при этом в самом документе есть маркер **[[toc]]**, то не добавляем заголовок.
|
|
12
|
+
- Если в YAML **toc: true**, тогда TOC рендерится даже если заголовков мало (в начале документа или на месте маркера **[[toc]]** при его наличии).
|
|
13
|
+
|
|
14
|
+
## Автоматическое отключение TOC для документов с количеством заголовков менее 3
|
|
15
|
+
- При наличии 1-3 заголовков TOC автоматически не вставляется (по умолчанию).
|
|
16
|
+
- Если заголовков более 3, то наличие заголовков выставляется по режиму, который настроил сам пользователь в настройках проекта для всего документа.
|
|
17
|
+
- **Нет зависимости от уровня вложенности заголовка, важно их количество**.
|
|
18
|
+
|
|
19
|
+
## Примеры использования гибкой настройки в Markdown-документах
|
|
20
|
+
1. Markdown-документ, содержащий 3 заголовка и более отображается с включенным автооглавлением по умолчанию, если пользователем не выбрано иное:
|
|
21
|
+
|
|
22
|
+
```yaml
|
|
23
|
+
...
|
|
24
|
+
seaf.no-toc:
|
|
25
|
+
type: markdown
|
|
26
|
+
location: SEAF.ArchTool/Руководство/Документы/Markdown/02 Отключение и перенос автооглавления/021 Пример TOC (по умолчанию)
|
|
27
|
+
source: test.md
|
|
28
|
+
...
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[Результат отображения Markdown-документа c TOC (по умолчанию)](/entities/docs/blank?dh-doc-id=seaf.no-toc)
|
|
32
|
+
|
|
33
|
+
2. Применив к этому документу флаг toc:false пользователь принудительно выключит автооглавление:
|
|
34
|
+
|
|
35
|
+
```yaml
|
|
36
|
+
...
|
|
37
|
+
seaf.toc-false:
|
|
38
|
+
type: markdown
|
|
39
|
+
toc: false
|
|
40
|
+
location: SEAF.ArchTool/Руководство/Документы/Markdown/02 Отключение и перенос автооглавления/022 Пример TOC с toc:false
|
|
41
|
+
source: test.md
|
|
42
|
+
...
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
[Результат отображения Markdown-документа с toc:false](/entities/docs/blank?dh-doc-id=seaf.toc-false)
|
|
46
|
+
|
|
47
|
+
3. В Markdown-документе с количестом заголовков менее 3 по умолчанию автооглавление отключено:
|
|
48
|
+
|
|
49
|
+
```yaml
|
|
50
|
+
...
|
|
51
|
+
seaf.two-header:
|
|
52
|
+
type: markdown
|
|
53
|
+
location: SEAF.ArchTool/Руководство/Документы/Markdown/02 Отключение и перенос автооглавления/023 Пример с 2мя заголовками (по умолчанию)
|
|
54
|
+
source: 2header.md
|
|
55
|
+
...
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
[Результат отображения Markdown-документа с 2мя заголовками (по умолчанию)](/entities/docs/blank?dh-doc-id=seaf.two-header)
|
|
59
|
+
|
|
60
|
+
4. В Markdown-документе с количестом заголовков менее 3 пользователь также может принудительно включить его:
|
|
61
|
+
|
|
62
|
+
```yaml
|
|
63
|
+
...
|
|
64
|
+
seaf.toc-true:
|
|
65
|
+
type: markdown
|
|
66
|
+
toc: true
|
|
67
|
+
location: SEAF.ArchTool/Руководство/Документы/Markdown/02 Отключение и перенос автооглавления/024 Пример с 2мя заголовками и toc:true
|
|
68
|
+
source: 2header.md
|
|
69
|
+
...
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
[Результат отображения Markdown-документа с 2мя заголовками и toc:true](/entities/docs/blank?dh-doc-id=seaf.toc-true)
|
|
73
|
+
|
|
74
|
+
5. Маркер **[[toc]]** позволяет указать место размещения оглавления:
|
|
75
|
+
|
|
76
|
+
```
|
|
77
|
+
### 1.1.2 Источники данных
|
|
78
|
+
- Базы данных
|
|
79
|
+
- API
|
|
80
|
+
- CSV-файлы
|
|
81
|
+
- Web scraping
|
|
82
|
+
|
|
83
|
+
Оглавление:
|
|
84
|
+
|
|
85
|
+
[[toc]]
|
|
86
|
+
|
|
87
|
+
### 1.1.3 Роль аналитика данных
|
|
88
|
+
Аналитик данных:
|
|
89
|
+
- Собирает и обрабатывает данные
|
|
90
|
+
- Строит визуализации
|
|
91
|
+
- Делает выводы и прогнозы
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
[Результат отображения Markdown-документа с применением маркера [[toc]]](/entities/docs/blank?dh-doc-id=seaf.custom-toc)
|
|
95
|
+
|
|
96
|
+
6. В случае использования маркера **[[toc]]** и **toc:false** флаг имеет высший приоритет:
|
|
97
|
+
|
|
98
|
+
```yaml
|
|
99
|
+
...
|
|
100
|
+
seaf.custom-toc-and-toc-false:
|
|
101
|
+
type: markdown
|
|
102
|
+
toc: false
|
|
103
|
+
location: SEAF.ArchTool/Руководство/Документы/Markdown/02 Отключение и перенос автооглавления/026 Пример с маркером [[toc]] и toc:false
|
|
104
|
+
source: custom-toc-place.md
|
|
105
|
+
...
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
[Результат отображения Markdown-документа с маркером [[toc]] и toc:false](/entities/docs/blank?dh-doc-id=seaf.custom-toc-and-toc-false)
|
|
109
|
+
|
|
110
|
+
7. В документах с двумя маркерами [[toc]], первый из них имеет высший приоритет:
|
|
111
|
+
|
|
112
|
+
```
|
|
113
|
+
### 1.1.2 Источники данных
|
|
114
|
+
- Базы данных
|
|
115
|
+
- API
|
|
116
|
+
- CSV-файлы
|
|
117
|
+
- Web scraping
|
|
118
|
+
|
|
119
|
+
Оглавление:
|
|
120
|
+
|
|
121
|
+
[[toc]]
|
|
122
|
+
|
|
123
|
+
### 1.1.3 Роль аналитика данных
|
|
124
|
+
Аналитик данных:
|
|
125
|
+
- Собирает и обрабатывает данные
|
|
126
|
+
- Строит визуализации
|
|
127
|
+
- Делает выводы и прогнозы
|
|
128
|
+
|
|
129
|
+
[[toc]]
|
|
130
|
+
|
|
131
|
+
## 1.2 Подходы к анализу
|
|
132
|
+
|
|
133
|
+
### 1.2.1 Описательный анализ
|
|
134
|
+
Используется для описания того, что уже произошло.
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
[Результат отображения Markdown-документа с двумя маркерами [[toc]]](/entities/docs/blank?dh-doc-id=seaf.custom-toc-dup)
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Этапы развития бизнеса
|
|
2
|
+
|
|
3
|
+

|
|
4
|
+
|
|
5
|
+
На ранних стадиях владельцем архитектурного замысла является создатель бизнеса. С этапа "Давай-давай" начинается
|
|
6
|
+
бурный рост организации. В управление архитектурным замыслом вовлекаются все больше число участников.
|
|
7
|
+
|
|
8
|
+
Именно здесь, чаще всего, организация начинает осознавать потребность в управлении своей архитектурой.
|
|
9
|
+
|
|
10
|
+
Важно отметить, что с ростом зрелости меняется и суть потребности в управлении архитектурой. На ранних
|
|
11
|
+
этапах развития бизнес стремится занять свою нишу на рынке. Его потребность в архитектурной функции можно выразить так:
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
Генерация архитектурных решений для получения конкурентных преимуществ на целевом рынке.
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Для этапа свойственны:
|
|
18
|
+
1. Потребность в быстрых проверках гипотез, что выражается в минимизации времени поставки ценности клиенту;
|
|
19
|
+
2. Высокая мутабельность процессов;
|
|
20
|
+
3. Роли чаще всего нечеткие и часто меняющиеся;
|
|
21
|
+
4. Готовность рисковать;
|
|
22
|
+
5. В приоритет ставятся маркетинговые показатели и выручка, а не прибыль;
|
|
23
|
+
6. Слабая документарная база.
|
|
24
|
+
|
|
25
|
+
**В приоритете скорость и уникальность поставляемых ценностей клиенту.**
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
Примерно на этапе "Расцвет" бизнес выходит на плато роста. В его фокусе появляется эффективность.
|
|
29
|
+
|
|
30
|
+
```
|
|
31
|
+
Генерация архитектурных решений для эффективного использования доступных ресурсов с целью доминирования на рынке.
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Для этапа свойственны:
|
|
35
|
+
1. Отдельные маркетинговые активности, результат которых позволяет судить о необходимости что-то менять;
|
|
36
|
+
2. Фиксация успешных процессов в качестве стандартов организации;
|
|
37
|
+
3. Формирование ясной структуры организации;
|
|
38
|
+
4. Управление рисками;
|
|
39
|
+
5. В приоритет ставятся рентабельность и прибыльность;
|
|
40
|
+
6. Документарная база ярко выражена.
|
|
41
|
+
|
|
42
|
+
**В приоритете эффективность и адаптивность к меняющимся условиям рынка.**
|
|
43
|
+
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
# Пакеты. Руководство пользователя
|
|
2
|
+
|
|
3
|
+
## Что такое пакет
|
|
4
|
+
|
|
5
|
+
Пакет - самодостаточная, отчуждаемая часть кода архитектуры. Он может содержать все то же, что обычный код.
|
|
6
|
+
Целью его создания является переиспользование архитектурного кода в сторонних архитектурных кодовых базах
|
|
7
|
+
в качестве зависимости.
|
|
8
|
+
|
|
9
|
+
Например, можно создать пакет описывающий вашу корпоративную архитектурную нотацию и передать командам как
|
|
10
|
+
общий стандарт описания архитектуры. Пример создания нотации C4 Model можно посмотреть
|
|
11
|
+
[здесь](https://github.com/rpiontik/DocHubExamples/tree/main/src/C4Model).
|
|
12
|
+
|
|
13
|
+
Рекомендуется следующая файловая структура пакета:
|
|
14
|
+
```
|
|
15
|
+
.\C4Model\ - Идентификатор пакета
|
|
16
|
+
.\C4Model\Entities\ - Сущности, которые содержит в себе пакет
|
|
17
|
+
.\C4Model\Validators\ - Валидаторы
|
|
18
|
+
.\C4Model\Datasets\ - Источники данных
|
|
19
|
+
.\C4Model\Docs\ - Документы
|
|
20
|
+
.\C4Model\dochub.yaml - Корневой манифест
|
|
21
|
+
.\C4Model\README.md - Описание пакета
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Структура файла пакета
|
|
25
|
+
|
|
26
|
+
Пакет описывается в YAML-файле и начинается с раздела $package.
|
|
27
|
+
|
|
28
|
+
Пример:
|
|
29
|
+
``` yaml
|
|
30
|
+
$package:
|
|
31
|
+
mypack:
|
|
32
|
+
version: 1.1
|
|
33
|
+
name: My Package
|
|
34
|
+
description: Пример пакета
|
|
35
|
+
license: MIT
|
|
36
|
+
|
|
37
|
+
imports:
|
|
38
|
+
- mm/root.yaml
|
|
39
|
+
|
|
40
|
+
entities:
|
|
41
|
+
myEntity:
|
|
42
|
+
name: Example entity
|
|
43
|
+
```
|
|
44
|
+
После раздела $package в файле могут располагаться любые разделы манифеста.
|
|
45
|
+
|
|
46
|
+
## Описание пакета
|
|
47
|
+
|
|
48
|
+
Минимальное объявление пакета:
|
|
49
|
+
``` yaml
|
|
50
|
+
$package:
|
|
51
|
+
mypack:
|
|
52
|
+
version: 1.1
|
|
53
|
+
```
|
|
54
|
+
### Обязательные параметры
|
|
55
|
+
|
|
56
|
+
* packageId (mypack в примере выше) — идентификатор пакета.
|
|
57
|
+
* version — версия пакета.
|
|
58
|
+
|
|
59
|
+
### Рекомендуемые параметры
|
|
60
|
+
|
|
61
|
+
Хотя они не обязательны, рекомендуется указывать:
|
|
62
|
+
|
|
63
|
+
* name — название пакета;
|
|
64
|
+
* description — описание назначения пакета;
|
|
65
|
+
* license — лицензию использования.
|
|
66
|
+
|
|
67
|
+
Пример:
|
|
68
|
+
``` yaml
|
|
69
|
+
$package:
|
|
70
|
+
mypack:
|
|
71
|
+
version: 1.1
|
|
72
|
+
name: User Management
|
|
73
|
+
description: Пакет с сущностями пользователей и ролей
|
|
74
|
+
license: Apache License, Version 2.0
|
|
75
|
+
```
|
|
76
|
+
Эти поля не влияют на работу пакета, но делают его понятнее для других пользователей.
|
|
77
|
+
|
|
78
|
+
## Подключение пакетов
|
|
79
|
+
|
|
80
|
+
Каждый пакет объявляется в отдельном файле.
|
|
81
|
+
|
|
82
|
+
Пакеты подключаются через imports в корневом манифесте или в других пакетах:
|
|
83
|
+
|
|
84
|
+
``` yaml
|
|
85
|
+
imports:
|
|
86
|
+
- packages/user-management.yaml
|
|
87
|
+
- packages/core.yaml
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### Порядок обработки
|
|
91
|
+
|
|
92
|
+
1. Система валидирует объявление пакета.
|
|
93
|
+
2. Проверяет зависимости.
|
|
94
|
+
3. Если все зависимости разрешены, обрабатывает содержимое пакета.
|
|
95
|
+
4. Если зависимости не разрешены, обработка пакета прекращается.
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
## Правила использования пакетов
|
|
99
|
+
|
|
100
|
+
При работе с пакетами действуют следующие правила:
|
|
101
|
+
|
|
102
|
+
* идентификатор пакета должен быть уникальным;
|
|
103
|
+
* версия пакета должна быть указана;
|
|
104
|
+
* нельзя подключать один и тот же пакет в разных версиях;
|
|
105
|
+
* пакет может содержать архитектурный код (imports, entities или другие разделы).
|