Skip to content

Commit

Permalink
Merge pull request #192 from max-arshinov/ru
Browse files Browse the repository at this point in the history
RU translation, again. Thanx to @max-arshinov
  • Loading branch information
gernotstarke committed Jul 25, 2023
2 parents a2a654a + a8fad2f commit d45afa7
Show file tree
Hide file tree
Showing 15 changed files with 940 additions and 0 deletions.
100 changes: 100 additions & 0 deletions RU/asciidoc/arc42-template.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
// header file for arc42-template,
// including all help texts
//
// ====================================

// configure EN settings for asciidoc
include::src/config.adoc[]

= image:arc42-logo.png[arc42] Шаблон
:revnumber: 8.2 RU
:revdate: Январь 2023
:revremark: (основана на версии AsciiDoc)
// toc-title definition MUST follow document title without blank line!
:toc-title: Оглавление

//additional style for arc42 help callouts
ifdef::backend-html5[]
++++
<style>
.arc42help {font-size:small; width: 14px; height: 16px; overflow: hidden; position: absolute; right: 0; padding: 2px 0 3px 2px;}
.arc42help::before {content: "?";}
.arc42help:hover {width:auto; height: auto; z-index: 100; padding: 10px;}
.arc42help:hover::before {content: "";}
@media print {
.arc42help {display:none;}
}
</style>
++++
endif::backend-html5[]


include::src/about-arc42.adoc[]

// horizontal line
***

[role="arc42help"]
****
[NOTE]
====
Эта версия шаблона содержит подсказки и пояснения.
Используйте для ознакомления с arc42 и понимания концепций.
Для документирования собственной системы лучше использовать _простую(plain)_ версию.
====
****


// numbering from here on
:numbered:

<<<<
// 1. Introduction and Goals
include::src/01_introduction_and_goals.adoc[]

<<<<
// 2. Architecture Constraints
include::src/02_architecture_constraints.adoc[]

<<<<
// 3. Context and Scope
include::src/03_context_and_scope.adoc[]

<<<<
// 4. Solution Strategy
include::src/04_solution_strategy.adoc[]

<<<<
// 5. Building Block View
include::src/05_building_block_view.adoc[]

<<<<
// 6. Runtime View
include::src/06_runtime_view.adoc[]

<<<<
// 7. Deployment View
include::src/07_deployment_view.adoc[]

<<<<
// 8. Concepts
include::src/08_concepts.adoc[]

<<<<
// 9. Architecture Decisions
include::src/09_architecture_decisions.adoc[]

<<<<
// 10. Quality Requirements
include::src/10_quality_requirements.adoc[]

<<<<
// 11. Technical Risks
include::src/11_technical_risks.adoc[]

<<<<
// 12. Glossary
include::src/12_glossary.adoc[]


92 changes: 92 additions & 0 deletions RU/asciidoc/src/01_introduction_and_goals.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
ifndef::imagesdir[:imagesdir: ../images]

[[section-introduction-and-goals]]
== Введение и цели

[role="arc42help"]
****
Описывает соответствующие требования и движущие силы, которые должны учитывать архитекторы программного обеспечения и команда разработчиков.
К ним относятся
* основные бизнес-цели,
* важные особенности,
* основные функциональные требования,
* цели в области качества архитектуры и
* соответствующие заинтересованные стороны и их ожидания
****

=== Обзор требований

[role="arc42help"]
****
.Содержание
Краткое описание функциональных требований, движущих сил, выжимка требований. Ссылка на (возможно, уже существующие) документы с требованиями
(с номером версии и информацией, где ее найти).
.Мотивация
С точки зрения конечных пользователей система создается или модифицируется, чтобы
улучшить поддержку деловой активности и/или улучшить качество.
.Форма
Краткое текстовое описание, вероятно, в табличном формате варианта использования.
Если существуют документы с требованиями, этот обзор должен ссылаться на эти документы.
Сделайте эти выдержки как можно короче. Соблюдайте баланс читабельности этого документа с потенциальной избыточностью по отношению к документам с требованиями
.Дальнейшая информация
Смотрите https://docs.arc42.org/section-1/[Введение и цели] в документации arc42.
****

=== Цели по качеству

[role="arc42help"]
****
.Содержание
Три (максимум пять) главных целей в области качества для архитектуры, выполнение которых имеет первостепенное значение для основных заинтересованных сторон.
Здесь действительно имеются в виду цели качества для архитектуры. Не путайте их с целями проекта.
Они необязательно совпадают.
Рассмотрите этот обзор потенциальных тем (на основе стандарта ISO 25010):
image::01_2_iso-25010-topics-EN.drawio.png["Категории требований по качеству"]
.Мотивация
Вы должны знать цели в области качества наиболее важных заинтересованных сторон, поскольку они будут влиять на фундаментальные архитектурные решения.
Убедитесь, что вы очень конкретно говорите об этих качествах, избегайте модных словечек.
Если вы как архитектор не знаете, как будет оцениваться качество вашей работы...
.Форма
Таблица с целями по качеству и конкретными сценариями, упорядоченными по приоритетам
****

=== Заинтересованные стороны

[role="arc42help"]
****
.Содержание
Подробный обзор заинтересованных сторон системы, т. е. всех лиц, ролей или организаций, которые
* должны знать архитектуру
* должны быть уверены в архитектуре
* работать с архитектурой или с кодом
* нуждаются в архитектурной документации для своей работы
* должны принимать решения о системе или ее развитии
.Мотивация
Вы должны знать все стороны, участвующие в разработке системы или затронутые системой.
В противном случае вы можете получить неприятные сюрпризы позже в процессе разработки.
Эти заинтересованные стороны определяют степень и уровень детализации вашей работы и ее результатов.
.Форма
Таблица именами людей, их ролями и ожиданиями в отношении архитектуры и ее документации.
****

[options="header",cols="1,2,2"]
|===
|Роль/Имя|Контактные данные|Ожидания
| _<Роль-1>_ | _<Контактные-данные-1>_ | _<Ожидания-1>_
| _<Роль-2>_ | _<Контактные-данные-2>_ | _<Ожидания-2>_
|===
27 changes: 27 additions & 0 deletions RU/asciidoc/src/02_architecture_constraints.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
ifndef::imagesdir[:imagesdir: ../images]

[[section-architecture-constraints]]
== Архитектурные ограничения


[role="arc42help"]
****
.Содержание
Любое требование, ограничивающее архитекторов программного обеспечения в их свободе проектирования и решений по реализации или в принятии решений о процессе разработки. Эти ограничения иногда выходят за рамки отдельных систем и действительны для целых организаций и компаний.
.Мотивация
Архитекторы должны точно знать, где они свободны в своих проектных решениях, а где должны придерживаться ограничений.
С ограничениями всегда нужно иметь дело; хотя они могут быть предметом переговоров.
.Форма
Простые таблицы ограничений с пояснениями.
При необходимости вы можете разделить их на
технические ограничения, организационные и политические ограничения и
соглашения (например, рекомендации по программированию или управлению версиями, документация или соглашения о наименованиях)
.Дальнейшая информация
Смотрите https://docs.arc42.org/section-2/[Архитектурные ограничения] в документации arc42.
****
74 changes: 74 additions & 0 deletions RU/asciidoc/src/03_context_and_scope.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
ifndef::imagesdir[:imagesdir: ../images]

[[section-context-and-scope]]
== Контекст и рамки


[role="arc42help"]
****
.Содержание
Контекст и область действия — как следует из названия — разграничивают вашу систему (ее рамки) от всех партнеров с которыми она коммуницирует (соседние системы и пользователи, т.е. контекст вашей системы). Таким образом, он определяет внешние интерфейсы.
При необходимости различайте бизнес-контекст (специфические для предметной области входы и выходы) и технический контекст (каналы, протоколы, аппаратное обеспечение).
.Мотивация
Интерфейсы домена и технические интерфейсы для коммуникационных партнеров являются одними из наиболее важных аспектов вашей системы. Убедитесь, что вы их полностью понимаете.
.Форма
Различные варианты:
* Контекстные диаграммы
* Списки коммуникационных партнеров и их интерфейсов.
.Дальнейшая информация
Смотрите https://docs.arc42.org/section-3/[Context and Scope] в документации arc42.
****


=== Бизнес контекст

[role="arc42help"]
****
.Содержание
Спецификация *всех* коммуникационных партнеров (пользователи, ИТ-системы, ...) с пояснениями входных и выходных данных или интерфейсов, специфичных для предметной области.
При желании вы можете добавить специфичные для домена форматы или протоколы связи.
.Мотивация
Все заинтересованные стороны должны понимать, какими данными система обменивается со средой.
.Форма
Все виды диаграмм, изображающих систему в виде черного ящика и определяющих интерфейсы домена для коммуникационных партнеров.
В качестве альтернативы (или дополнительно) можно использовать таблицу.
Заголовок таблицы — это имя вашей системы, три столбца содержат имя партнера, с которым происходит коммуникация, входы и выходы.
****

**<Диаграмма или таблица>**

**<необязательно: объяснение внешних доменных интерфейсов>**

=== Технический контекст

[role="arc42help"]
****
.Содержание
Технические интерфейсы (каналы и среды передачи), связывающие вашу систему с окружающей средой. Кроме того, сопоставление ввода/вывода, специфичного для предметной области, с каналами, то есть объяснение, какой ввод/вывод использует какой канал.
.Мотивация
Многие заинтересованные стороны принимают архитектурные решения на основе технических интерфейсов между системой и ее контекстом. Зачастую разработчики инфраструктуры или оборудования выбирают эти технические интерфейсы.
.Форма
Например, диаграмма развертывания UML, описывающая каналы к соседним системам,
вместе с таблицей сопоставления, показывающей взаимосвязь между каналами и вводом/выводом.
****

**<Диаграмма или таблица>**

**<необязательно: Пояснения к техническим интерфейсам>**

**<Сопоставление ввода/вывода с каналами>**
32 changes: 32 additions & 0 deletions RU/asciidoc/src/04_solution_strategy.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
ifndef::imagesdir[:imagesdir: ../images]

[[section-solution-strategy]]
== Стратегия решения


[role="arc42help"]
****
.Содержание
Краткое изложение и объяснение основных решений и стратегии, формирующих архитектуру системы. Они включают
* технологические решения
* решения о декомпозиции системы на верхнем уровне, т.е. использование архитектурного шаблона или шаблона проектирования
* решения о том, как достичь ключевых целей в области качества
* соответствующие организационные решения, т.е. выбор процесса разработки или делегирование определенных задач третьим лицам.
.Мотивация
Эти решения ложатся в основу вашей архитектуры. На них опираются многие другие более специфические решения или правила реализации.
.Форма
Объяснения таких ключевых решений должны быть короткими.
Мотивируйте решение (и почему было решено именно так)
на основе постановки задачи, целей в области качества и ключевых ограничений.
Подробности см. в следующих разделах.
.Дальнейшая информация
Смотрите https://docs.arc42.org/section-4/[Стратегия решения] в документации arc42.
****
Loading

0 comments on commit d45afa7

Please sign in to comment.