Merge pull request #185 from ascheman/feature/101-add-arc42help-toggle

Enable to start with arc42 help and switch it off later
arc42 · Jul 6, 2023 · a2a654a · a2a654a
2 parents 73dca4f + e946a29
commit a2a654a
Show file tree

Hide file tree

Showing 112 changed files with 467 additions and 39 deletions.
diff --git a/CZ/asciidoc/arc42-template.adoc b/CZ/asciidoc/arc42-template.adoc
@@ -34,6 +34,7 @@ include::src/about-arc42.adoc[]
 // horizontal line
 ***
 
+ifdef::arc42help[]
 [role="arc42help"]
 ****
 [POZNÁMKA]
@@ -42,8 +43,7 @@ Tato verze arc42 šablony obsahuje nápovědu a vysvětlivky a slouží proto k
 Pro dokumentaci vašeho vlastního systému použijte raději _plain_ verzi.
 ====
 ****
-
-
+endif::arc42help[]
 // numbering from here on
 :numbered:
 

diff --git a/CZ/asciidoc/src/01_introduction_and_goals.adoc b/CZ/asciidoc/src/01_introduction_and_goals.adoc
@@ -3,6 +3,7 @@ ifndef::imagesdir[:imagesdir: ../images]
 [[section-introduction-and-goals]]
 == Úvod a cíle
 
+ifdef::arc42help[]
 [role="arc42help"]
 ****
 Popisuje nejdůležitější požadavky a omezení, které musí softwaroví architekti a vývojový tým zvážit.
@@ -14,9 +15,11 @@ Tyto zahrnují
 * kvalitativní cíle pro architekturu,
 * strany zainteresované na systému (Stakeholder) a jejich potřeby
 ****
+endif::arc42help[]
 
 === Přehled požadavků
 
+ifdef::arc42help[]
 [role="arc42help"]
 ****
 .Obsah
@@ -37,9 +40,11 @@ Udržujte tento popis co nejkratší (z hlediska čitelnosti), ale tak aby nebyl
 Anglická dokumentace arc42: https://docs.arc42.org/section-1/[Introduction and Goals].
 
 ****
+endif::arc42help[]
 
 === Kvalitativní cíle
 
+ifdef::arc42help[]
 [role="arc42help"]
 ****
 .Obsah
@@ -57,9 +62,11 @@ Ujistěte se, že jsou tyto požadavky na systém jednoznačné (nebo měřiteln
 .Forma
 Tabulka s nejdůležitějšími kvalitativními cíli a konkrétními scénáři, seřazená podle priorit.
 ****
+endif::arc42help[]
 
 === Strany zainteresované na systému (Stakeholder)
 
+ifdef::arc42help[]
 [role="arc42help"]
 ****
 .Obsah
@@ -78,6 +85,7 @@ Tyto zainteresované strany určují rozsah a úroveň detailu vaší práce a j
 .Forma
 Tabulka s názvy rolí, jmény osob a jejich očekáváním na architekturu a její dokumentaci.
 ****
+endif::arc42help[]
 
 [options="header",cols="1,2,2"]
 |===

diff --git a/CZ/asciidoc/src/02_architecture_constraints.adoc b/CZ/asciidoc/src/02_architecture_constraints.adoc
@@ -4,6 +4,7 @@ ifndef::imagesdir[:imagesdir: ../images]
 == Omezení na realizaci systému
 
 
+ifdef::arc42help[]
 [role="arc42help"]
 ****
 .Obsah
@@ -24,3 +25,4 @@ V případě potřeby rozdělená na technická, organizační nebo politická o
 Anglická dokumentace arc42: https://docs.arc42.org/section-2/[Architecture Constraints].
 
 ****
+endif::arc42help[]
diff --git a/CZ/asciidoc/src/03_context_and_scope.adoc b/CZ/asciidoc/src/03_context_and_scope.adoc
@@ -4,6 +4,7 @@ ifndef::imagesdir[:imagesdir: ../images]
 == Vymezení a rozsah systému
 
 
+ifdef::arc42help[]
 [role="arc42help"]
 ****
 .Obsah
@@ -29,9 +30,11 @@ Anglická dokumentace arc42: https://docs.arc42.org/section-3/[Context and Scope
 
 
 ****
+endif::arc42help[]
 
 === Firemní kontext 
 
+ifdef::arc42help[]
 [role="arc42help"]
 ****
 .Obsah
@@ -48,13 +51,15 @@ Alternativně (nebo jako doplnění) můžete použít tabulku.
 Titulek tabulky je název systému, tři sloupce obsahují: jméno komunikačního partnera, vstupy a výstupy.
 
 ****
+endif::arc42help[]
 
 **<vložte diagram nebo tabulku>**
 
 **<(volitelně:) vložte vysvětlení externích doménových rozhraní>**
 
 === Technický kontext 
 
+ifdef::arc42help[]
 [role="arc42help"]
 ****
 .Obsah
@@ -68,6 +73,7 @@ Zejména při výběru infrastruktury nebo hardwaru jsou tato technická rozhran
 Např. UML Diagram popisující technické napojení sousedních systémů spolu s tabulkou ukazující vztahy mezi technickými kanály a doménovým vstupem/výstupem.
 
 ****
+endif::arc42help[]
 
 **<vložte diagram nebo tabulku>**
 

diff --git a/CZ/asciidoc/src/04_solution_strategy.adoc b/CZ/asciidoc/src/04_solution_strategy.adoc
@@ -4,6 +4,7 @@ ifndef::imagesdir[:imagesdir: ../images]
 == Strategie řešení
 
 
+ifdef::arc42help[]
 [role="arc42help"]
 ****
 .Obsah
@@ -31,3 +32,4 @@ Pro podrobnosti odkažte na následující části.
 Anglická dokumentace arc42: https://docs.arc42.org/section-4/[Solution Strategy].
 
 ****
+endif::arc42help[]
diff --git a/CZ/asciidoc/src/05_building_block_view.adoc b/CZ/asciidoc/src/05_building_block_view.adoc
@@ -5,6 +5,7 @@ ifndef::imagesdir[:imagesdir: ../images]
 
 == Perspektiva stavebních bloků
 
+ifdef::arc42help[]
 [role="arc42help"]
 ****
 .Obsah
@@ -34,9 +35,11 @@ Obsahuje tedy popis vybraných stavebních bloků úrovně 1 jako white-box spol
 Anglická dokumentace arc42: https://docs.arc42.org/section-5/[Building Block View].
 
 ****
+endif::arc42help[]
 
 === Celý systém jako white-box
 
+ifdef::arc42help[]
 [role="arc42help"]
 ****
 Zde popisujete rozklad celého systému pomocí následující white-box šablony. Obsahuje
@@ -56,6 +59,7 @@ V lepším případě vám stačí příklady nebo jednoduché podpisy.
 
 
 ****
+endif::arc42help[]
 
 _**<vložte přehledový diagram celého systému>**_
 
@@ -66,6 +70,7 @@ Obsažené stavební bloky :: _<popište obsažené stavební bloky (jako black-
 
 Důležitá rozhraní:: _<popište důležitá rozhraní>_
 
+ifdef::arc42help[]
 [role="arc42help"]
 ****
 Vložte vysvětlení black-boxů z úrovně 1:
@@ -82,10 +87,11 @@ Pokud použijete tabulkovou formu, popište black-boxy pouze jménem a odpovědn
 Pokud použijete seznam popisů jednotlivých black-boxů, vyplňte samostatnou black-box šablonu pro každý důležitý stavební blok. 
 Její titulek je název black-boxu.
 ****
-
+endif::arc42help[]
 
 ==== <Jméno black-boxu 1>
 
+ifdef::arc42help[]
 [role="arc42help"]
 ****
 Popište <black-box 1> podle následující black-box šablony:
@@ -98,6 +104,7 @@ Popište <black-box 1> podle následující black-box šablony:
 * (Volitelně) Nevyřešené body/problémy/rizika
 
 ****
+endif::arc42help[]
 
 _<Účel/Odpovědnost>_
 
@@ -131,20 +138,24 @@ _<šablona black-box>_
 
 === Úroveň 2
 
+ifdef::arc42help[]
 [role="arc42help"]
 ****
 Zde popište vnitřní strukturu (některých) stavebních bloků z úrovně 1 jako white-box.
 
 Musíte rozhodnout, které stavební bloky systému jsou natolik důležité, aby ospravedlnily tak podrobný popis. Upřednostněte relevanci před úplností. Uveďte důležité, překvapivé, riskantní, komplexní nebo volatilní stavební bloky. Vynechejte normální, jednoduché nebo standardizované části systému.
 
 ****
+endif::arc42help[]
 
 ==== white-box _<stavební blok 1>_
 
+ifdef::arc42help[]
 [role="arc42help"]
 ****
 ...popisuje vnitřní strukturu _stavebního bloku 1_.
 ****
+endif::arc42help[]
 
 _<šablona white-box>_
 
@@ -164,21 +175,23 @@ _<šablona white-box>_
 
 === Úroveň 3
 
+ifdef::arc42help[]
 [role="arc42help"]
 ****
 Zde můžete popsat vnitřní strukturu (některých) stavebních bloků z úrovně 2 jako white-box.
 
 Pokud potřebujete podrobnější úrovně architektury, zkopírujte si pro ně tuto část arc42.
 ****
-
+endif::arc42help[]
 
 ==== white-box <_stavební blok x.1_>
 
+ifdef::arc42help[]
 [role="arc42help"]
 ****
 ...popisuje vnitřní strukturu _stavebního bloku x.1_.
 ****
-
+endif::arc42help[]
 
 _<šablona white-box>_
 

diff --git a/CZ/asciidoc/src/06_runtime_view.adoc b/CZ/asciidoc/src/06_runtime_view.adoc
@@ -4,6 +4,7 @@ ifndef::imagesdir[:imagesdir: ../images]
 == Perspektiva chování za běhu (runtime)
 
 
+ifdef::arc42help[]
 [role="arc42help"]
 ****
 .Obsah
@@ -36,6 +37,7 @@ Existuje mnoho notací pro popis scénářů, např.
 
 Anglická dokumentace arc42: https://docs.arc42.org/section-6/[Runtime View].
 ****
+endif::arc42help[]
 
 === <Scénář runtime 1>
 

diff --git a/CZ/asciidoc/src/07_deployment_view.adoc b/CZ/asciidoc/src/07_deployment_view.adoc
@@ -5,6 +5,7 @@ ifndef::imagesdir[:imagesdir: ../images]
 
 == Perspektiva nasazení softwaru (deployment)
 
+ifdef::arc42help[]
 [role="arc42help"]
 ****
 .Obsah
@@ -42,9 +43,11 @@ když je infrastruktura složitější.
 Anglická dokumentace arc42: https://docs.arc42.org/section-7/[Deployment View].
 
 ****
+endif::arc42help[]
 
 === Úroveň infrastruktury 1
 
+ifdef::arc42help[]
 [role="arc42help"]
 ****
 Popište (obvykle kombinací diagramů, tabulek a textu):
@@ -56,6 +59,7 @@ Popište (obvykle kombinací diagramů, tabulek a textu):
 
 Pro více prostředí nebo alternativní nasazení zkopírujte a upravte tuto část arc42 pro všechna relevantní prostředí.
 ****
+endif::arc42help[]
 
 _**<Přehledový diagram>**_
 
@@ -73,12 +77,14 @@ _<popis mapování>_
 
 === Úroveň infrastruktury 2
 
+ifdef::arc42help[]
 [role="arc42help"]
 ****
 Zde můžete zahrnout vnitřní strukturu (některých) prvků infrastruktury z úrovně 1.
 
 Zkopírujte prosím strukturu z úrovně 1 pro každý vybraný prvek.
 ****
+endif::arc42help[]
 
 ==== _<prvek infrastruktury 1>_
 

diff --git a/CZ/asciidoc/src/08_concepts.adoc b/CZ/asciidoc/src/08_concepts.adoc
@@ -4,6 +4,7 @@ ifndef::imagesdir[:imagesdir: ../images]
 == Průřezové (cross-cutting) koncepty
 
 
+ifdef::arc42help[]
 [role="arc42help"]
 ****
 .Obsah
@@ -53,7 +54,7 @@ image::08-Crosscutting-Concepts-Structure-EN.png["Témata pro průřezové konce
 
 Anglická dokumentace arc42: https://docs.arc42.org/section-8/[Concepts].
 ****
-
+endif::arc42help[]
 
 === _<Koncept 1>_
 

diff --git a/CZ/asciidoc/src/09_architecture_decisions.adoc b/CZ/asciidoc/src/09_architecture_decisions.adoc
@@ -4,6 +4,7 @@ ifndef::imagesdir[:imagesdir: ../images]
 == Rozhodnutí o architektuře
 
 
+ifdef::arc42help[]
 [role="arc42help"]
 ****
 .Obsah
@@ -33,3 +34,4 @@ Anglická dokumentace arc42: https://docs.arc42.org/section-9/[Architecture Deci
 Zde najdete odkazy a příklady k tématu *ADR*.
 
 ****
+endif::arc42help[]
diff --git a/CZ/asciidoc/src/10_quality_requirements.adoc b/CZ/asciidoc/src/10_quality_requirements.adoc
@@ -4,9 +4,9 @@ ifndef::imagesdir[:imagesdir: ../images]
 == Požadavky na kvalitu
 
 
+ifdef::arc42help[]
 [role="arc42help"]
 ****
-
 .Obsah
 Tato část obsahuje všechny požadavky na kvalitu jako strom kvality se scénáři. Ty nejdůležitější již byly popsány v části 1.2. (kvalitativní cíle pro architekturu)
 
@@ -21,9 +21,11 @@ Protože požadavky na kvalitu mají na architekturu velký vliv, je důležité
 Anglická dokumentace arc42: https://docs.arc42.org/section-10/[Quality Requirements].
 
 ****
+endif::arc42help[]
 
 === Strom kvality
 
+ifdef::arc42help[]
 [role="arc42help"]
 ****
 .Obsah
@@ -41,9 +43,11 @@ Stromová struktura s prioritami poskytuje přehled o někdy velkém množství
 V každém případě by strom měl obsahovat odkazy na scénáře popsané v následující části dokumentace.
 
 ****
+endif::arc42help[]
 
 === Scénáře kvality
 
+ifdef::arc42help[]
 [role="arc42help"]
 ****
 .Obsah
@@ -66,3 +70,4 @@ přesněji až na úroveň jednotlivých scénářů, které lze diskutovat a vy
 .Forma
 Tabulka nebo text.
 ****
+endif::arc42help[]
diff --git a/CZ/asciidoc/src/11_technical_risks.adoc b/CZ/asciidoc/src/11_technical_risks.adoc
@@ -4,6 +4,7 @@ ifndef::imagesdir[:imagesdir: ../images]
 == Rizika a technické dluhy
 
 
+ifdef::arc42help[]
 [role="arc42help"]
 ****
 .Obsah
@@ -24,3 +25,4 @@ Seznam rizik a/nebo technických dluhů, pravděpodobně včetně navrhovaných
 Anglická dokumentace arc42: https://docs.arc42.org/section-11/[Risks and Technical Debt].
 
 ****
+endif::arc42help[]