updating doc

Arquisoft · Jan 25, 2022 · 131f930 · 131f930
1 parent 72884c7
commit 131f930
Show file tree

Hide file tree

Showing 19 changed files with 142 additions and 46 deletions.
diff --git a/docs/src/01_introduction_and_goals.adoc → docs/01_introduction_and_goals.adoc b/docs/src/01_introduction_and_goals.adoc → docs/01_introduction_and_goals.adoc
diff --git a/docs/src/02_architecture_constraints.adoc → docs/02_architecture_constraints.adoc b/docs/src/02_architecture_constraints.adoc → docs/02_architecture_constraints.adoc
diff --git a/docs/src/03_system_scope_and_context.adoc → docs/03_system_scope_and_context.adoc b/docs/src/03_system_scope_and_context.adoc → docs/03_system_scope_and_context.adoc
diff --git a/docs/src/04_solution_strategy.adoc → docs/04_solution_strategy.adoc b/docs/src/04_solution_strategy.adoc → docs/04_solution_strategy.adoc
diff --git a/docs/src/05_building_block_view.adoc → docs/05_building_block_view.adoc b/docs/src/05_building_block_view.adoc → docs/05_building_block_view.adoc
diff --git a/docs/src/06_runtime_view.adoc → docs/06_runtime_view.adoc b/docs/src/06_runtime_view.adoc → docs/06_runtime_view.adoc
@@ -37,6 +37,19 @@ There are many notations for describing scenarios, e.g.
 * _<insert description of the notable aspects of the interactions between the
 building block instances depicted in this diagram.>_
 
+It is possible to use a sequence diagram:
+
+[plantuml,"Sequence diagram",png]
+----
+actor Alice
+actor Bob
+database Pod as "Bob's Pod"
+Alice -> Bob: Authentication Request
+Bob --> Alice: Authentication Response
+Alice  --> Pod: Store route
+Alice -> Bob: Another authentication Request
+Alice <-- Bob: another authentication Response
+----
 === <Runtime Scenario 2>
 
 === ...

diff --git a/docs/src/07_deployment_view.adoc → docs/07_deployment_view.adoc b/docs/src/07_deployment_view.adoc → docs/07_deployment_view.adoc
diff --git a/docs/src/08_concepts.adoc → docs/08_concepts.adoc b/docs/src/08_concepts.adoc → docs/08_concepts.adoc
@@ -50,9 +50,9 @@ image:08-Crosscutting-Concepts-Structure-EN.png["Possible topics for crosscuttin
 ****
 
 
-=== _<Concept 1>_
+=== Domain model
 
-_<explanation>_
+image:UmlDiagram.png["Example UML Diagram"]
 
 
 

diff --git a/docs/src/09_design_decisions.adoc → docs/09_design_decisions.adoc b/docs/src/09_design_decisions.adoc → docs/09_design_decisions.adoc
diff --git a/docs/src/10_quality_scenarios.adoc → docs/10_quality_scenarios.adoc b/docs/src/10_quality_scenarios.adoc → docs/10_quality_scenarios.adoc
diff --git a/docs/src/11_technical_risks.adoc → docs/11_technical_risks.adoc b/docs/src/11_technical_risks.adoc → docs/11_technical_risks.adoc
diff --git a/docs/src/12_glossary.adoc → docs/12_glossary.adoc b/docs/src/12_glossary.adoc → docs/12_glossary.adoc
@@ -1,6 +1,8 @@
 [[section-glossary]]
 == Glossary
 
+
+
 [role="arc42help"]
 ****
 .Contents
@@ -15,17 +17,15 @@ You should clearly define your terms, so that all stakeholders
 * do not use synonyms and homonyms
 
 .Form
-* A table with columns <Term> and <Definition>.
-* Potentially more columns in case you need translations.
-****
+A table with columns <Term> and <Definition>.
 
-[cols="e,2e" options="header"]
-|===
-|Term |Definition
+Potentially more columns in case you need translations.
 
-|<Term-1>
-|<definition-1>
+****
 
-|<Term-2>
-|<definition-2>
+[options="header"]
+|===
+| Term         | Definition
+| <Term-1>     | <definition-1>
+| <Term-2>     | <definition-2>
 |===
diff --git a/docs/src/about-arc42.adoc → docs/about-arc42.adoc b/docs/src/about-arc42.adoc → docs/about-arc42.adoc
@@ -6,8 +6,6 @@
 **About arc42**
 
 [role="lead"]
-ASW21_22
-
 arc42, the Template for documentation of
 software and system architecture.
 

diff --git a/docs/arc42-template.adoc b/docs/arc42-template.adoc
@@ -0,0 +1,96 @@
+// header file for arc42-template,
+// including all help texts
+//
+// ====================================
+
+= image:arc42-logo.png[arc42] Template
+// toc-title definition MUST follow document title without blank line!
+:toc-title: Table of Contents
+
+//additional style for arc42 help callouts
+ifdef::basebackend-html[]
+++++
+<style>
+.arc42help {font-size:small; width: 14px; height: 16px; overflow: hidden; position: absolute; right: 0px; padding: 2px 0px 3px 2px;}
+.arc42help::before {content: "?";}
+.arc42help:hover {width:auto; height: auto; z-index: 100; padding: 10px;}
+.arc42help:hover::before {content: "";}
+@media print {
+	.arc42help {display:hidden;}
+}
+</style>
+++++
+endif::basebackend-html[]
+
+// configure EN settings for asciidoc
+include::src/config.adoc[]
+
+
+include::src/about-arc42.adoc[]
+
+// horizontal line
+***
+
+[role="arc42help"]
+****
+[NOTE]
+====
+This version of the template contains some help and explanations.
+It is used for familiarization with arc42 and the understanding of the concepts.
+For documentation of your own system you use better the _plain_ version.
+====
+****
+
+
+// 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. System Scope and Context
+include::src/03_system_scope_and_context.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. Design Decisions
+include::src/09_design_decisions.adoc[]
+
+<<<<
+// 10. Quality Scenarios
+include::src/10_quality_scenarios.adoc[]
+
+<<<<
+// 11. Technical Risks
+include::src/11_technical_risks.adoc[]
+
+<<<<
+// 12. Glossary
+include::src/12_glossary.adoc[]
+
+
diff --git a/docs/images/08-Crosscutting-Concepts-Structure-EN.png b/docs/images/08-Crosscutting-Concepts-Structure-EN.png
diff --git a/docs/images/LogoASW.png b/docs/images/LogoASW.png
diff --git a/docs/images/UmlDiagram.png b/docs/images/UmlDiagram.png
diff --git a/docs/index.adoc b/docs/index.adoc
@@ -2,15 +2,16 @@
 // including all help texts
 //
 // ====================================
-:toc: left
-:toc-title: Table of Contents
 
-= image:arc42-logo.png[arc42] Template
+= image:LogoASW.png[arc42] ASW2122
 // toc-title definition MUST follow document title without blank line!
+:toc: left
 :toc-title: Table of Contents
+:imagesdir: ./images
+
 
 //additional style for arc42 help callouts
-ifdef::backend-html5[]
+ifdef::basebackend-html[]
 ++++
 <style>
 .arc42help {font-size:small; width: 14px; height: 16px; overflow: hidden; position: absolute; right: 0px; padding: 2px 0px 3px 2px;}
@@ -22,13 +23,8 @@ ifdef::backend-html5[]
 }
 </style>
 ++++
-endif::backend-html5[]
+endif::basebackend-html[]
 
-// configure EN settings for asciidoc
-include::src/config.adoc[]
-
-
-include::src/about-arc42.adoc[]
 
 // horizontal line
 ***
@@ -49,50 +45,52 @@ For documentation of your own system you use better the _plain_ version.
 
 <<<<
 // 1. Introduction and Goals
-include::src/01_introduction_and_goals.adoc[]
+include::01_introduction_and_goals.adoc[]
 
 <<<<
 // 2. Architecture Constraints
-include::src/02_architecture_constraints.adoc[]
+include::02_architecture_constraints.adoc[]
 
 <<<<
 // 3. System Scope and Context
-include::src/03_system_scope_and_context.adoc[]
+include::03_system_scope_and_context.adoc[]
 
 <<<<
 // 4. Solution Strategy
-include::src/04_solution_strategy.adoc[]
+include::04_solution_strategy.adoc[]
 
 <<<<
 // 5. Building Block View
-include::src/05_building_block_view.adoc[]
+include::05_building_block_view.adoc[]
 
 <<<<
 // 6. Runtime View
-include::src/06_runtime_view.adoc[]
+include::06_runtime_view.adoc[]
 
 <<<<
 // 7. Deployment View
-include::src/07_deployment_view.adoc[]
+include::07_deployment_view.adoc[]
 
 <<<<
 // 8. Concepts
-include::src/08_concepts.adoc[]
+include::08_concepts.adoc[]
 
 <<<<
 // 9. Design Decisions
-include::src/09_design_decisions.adoc[]
+include::09_design_decisions.adoc[]
 
 <<<<
 // 10. Quality Scenarios
-include::src/10_quality_scenarios.adoc[]
+include::10_quality_scenarios.adoc[]
 
 <<<<
 // 11. Technical Risks
-include::src/11_technical_risks.adoc[]
+include::11_technical_risks.adoc[]
 
 <<<<
 // 12. Glossary
-include::src/12_glossary.adoc[]
-
+include::12_glossary.adoc[]
 
+<<<<
+// About
+include::about-arc42.adoc[]
diff --git a/docs/src/config.adoc b/docs/src/config.adoc