Merge pull request #84 from arc42/76-add-doctoolchain-to-documentation

added docToolchain and arc42 plain template

.gitignore

@@ -6,3 +6,5 @@ node_modules
 Gemfile.lock
 *.bkp
 *.dtmp
+.gradle
+build

documentation/arc42/.asciidoctorconfig.adoc

@@ -0,0 +1,2 @@
+:imagesdir: ../images
+

documentation/arc42/arc42.adoc

@@ -0,0 +1,93 @@
+:imagesdir: ../images
+:jbake-menu: -
+// header file for arc42-template,
+// including all help texts
+//
+// ====================================
+
+// configure EN settings for asciidoc
+include::chapters/config.adoc[]
+
+= image:arc42-logo.png[arc42] Template
+:revnumber: 8.2 EN
+:revdate: January 2023
+:revremark: (based upon AsciiDoc version)
+// toc-title definition MUST follow document title without blank line!
+:toc-title: Table of Contents
+
+//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::chapters/about-arc42.adoc[]
+
+// horizontal line
+***
+
+
+
+
+// numbering from here on
+:numbered:
+
+<<<<
+// 1. Introduction and Goals
+include::chapters/01_introduction_and_goals.adoc[]
+
+<<<<
+// 2. Architecture Constraints
+include::chapters/02_architecture_constraints.adoc[]
+
+<<<<
+// 3. System Scope and Context
+include::chapters/03_system_scope_and_context.adoc[]
+
+<<<<
+// 4. Solution Strategy
+include::chapters/04_solution_strategy.adoc[]
+
+<<<<
+// 5. Building Block View
+include::chapters/05_building_block_view.adoc[]
+
+<<<<
+// 6. Runtime View
+include::chapters/06_runtime_view.adoc[]
+
+<<<<
+// 7. Deployment View
+include::chapters/07_deployment_view.adoc[]
+
+<<<<
+// 8. Concepts
+include::chapters/08_concepts.adoc[]
+
+<<<<
+// 9. Architecture Decisions
+include::chapters/09_architecture_decisions.adoc[]
+
+<<<<
+// 10. Quality Requirements
+include::chapters/10_quality_requirements.adoc[]
+
+<<<<
+// 11. Technical Risks
+include::chapters/11_technical_risks.adoc[]
+
+<<<<
+// 12. Glossary
+include::chapters/12_glossary.adoc[]
+
+

documentation/arc42/chapters/.asciidoctorconfig.adoc

@@ -0,0 +1,2 @@
+:imagesdir: ../../images
+

documentation/arc42/chapters/01_introduction_and_goals.adoc

@@ -0,0 +1,35 @@
+:jbake-title: Introduction and Goals
+:jbake-type: page_toc
+:jbake-status: published
+:jbake-menu: arc42
+:jbake-order: 1
+:filename: /chapters/01_introduction_and_goals.adoc
+ifndef::imagesdir[:imagesdir: ../../images]
+
+:toc:
+
+
+
+[[section-introduction-and-goals]]
+== Introduction and Goals
+
+
+
+=== Requirements Overview
+
+
+
+=== Quality Goals
+
+
+
+=== Stakeholders
+
+
+
+[options="header",cols="1,2,2"]
+|===
+|Role/Name|Contact|Expectations
+| _<Role-1>_ | _<Contact-1>_ | _<Expectation-1>_
+| _<Role-2>_ | _<Contact-2>_ | _<Expectation-2>_
+|===

documentation/arc42/chapters/02_architecture_constraints.adoc

@@ -0,0 +1,17 @@
+:jbake-title: Architecture Constraints
+:jbake-type: page_toc
+:jbake-status: published
+:jbake-menu: arc42
+:jbake-order: 2
+:filename: /chapters/02_architecture_constraints.adoc
+ifndef::imagesdir[:imagesdir: ../../images]
+
+:toc:
+
+
+
+[[section-architecture-constraints]]
+== Architecture Constraints
+
+
+

documentation/arc42/chapters/03_system_scope_and_context.adoc

@@ -0,0 +1,36 @@
+:jbake-title: System Scope and Context
+:jbake-type: page_toc
+:jbake-status: published
+:jbake-menu: arc42
+:jbake-order: 3
+:filename: /chapters/03_system_scope_and_context.adoc
+ifndef::imagesdir[:imagesdir: ../../images]
+
+:toc:
+
+
+
+[[section-system-scope-and-context]]
+== System Scope and Context
+
+
+
+
+
+=== Business Context
+
+
+
+**<Diagram or Table>**
+
+**<optionally: Explanation of external domain interfaces>**
+
+=== Technical Context
+
+
+
+**<Diagram or Table>**
+
+**<optionally: Explanation of technical interfaces>**
+
+**<Mapping Input/Output to Channels>**

documentation/arc42/chapters/04_solution_strategy.adoc

@@ -0,0 +1,17 @@
+:jbake-title: Solution Strategy
+:jbake-type: page_toc
+:jbake-status: published
+:jbake-menu: arc42
+:jbake-order: 4
+:filename: /chapters/04_solution_strategy.adoc
+ifndef::imagesdir[:imagesdir: ../../images]
+
+:toc:
+
+
+
+[[section-solution-strategy]]
+== Solution Strategy
+
+
+

documentation/arc42/chapters/05_building_block_view.adoc

@@ -0,0 +1,121 @@
+:jbake-title: Building Block View
+:jbake-type: page_toc
+:jbake-status: published
+:jbake-menu: arc42
+:jbake-order: 5
+:filename: /chapters/05_building_block_view.adoc
+ifndef::imagesdir[:imagesdir: ../../images]
+
+:toc:
+
+
+
+[[section-building-block-view]]
+
+
+== Building Block View
+
+
+
+=== Whitebox Overall System
+
+
+
+_**<Overview Diagram>**_
+
+Motivation::
+
+_<text explanation>_
+
+
+Contained Building Blocks::
+_<Description of contained building block (black boxes)>_
+
+Important Interfaces::
+_<Description of important interfaces>_
+
+
+
+
+==== <Name black box 1>
+
+
+
+_<Purpose/Responsibility>_
+
+_<Interface(s)>_
+
+_<(Optional) Quality/Performance Characteristics>_
+
+_<(Optional) Directory/File Location>_
+
+_<(Optional) Fulfilled Requirements>_
+
+_<(optional) Open Issues/Problems/Risks>_
+
+
+
+
+==== <Name black box 2>
+
+_<black box template>_
+
+==== <Name black box n>
+
+_<black box template>_
+
+
+==== <Name interface 1>
+
+...
+
+==== <Name interface m>
+
+
+
+=== Level 2
+
+
+
+==== White Box _<building block 1>_
+
+
+
+_<white box template>_
+
+==== White Box _<building block 2>_
+
+
+_<white box template>_
+
+...
+
+==== White Box _<building block m>_
+
+
+_<white box template>_
+
+
+
+=== Level 3
+
+
+
+
+==== White Box <_building block x.1_>
+
+
+
+
+_<white box template>_
+
+
+==== White Box <_building block x.2_>
+
+_<white box template>_
+
+
+
+==== White Box <_building block y.1_>
+
+_<white box template>_

documentation/arc42/chapters/06_runtime_view.adoc

@@ -0,0 +1,30 @@
+:jbake-title: Runtime View
+:jbake-type: page_toc
+:jbake-status: published
+:jbake-menu: arc42
+:jbake-order: 6
+:filename: /chapters/06_runtime_view.adoc
+ifndef::imagesdir[:imagesdir: ../../images]
+
+:toc:
+
+
+
+[[section-runtime-view]]
+== Runtime View
+
+
+
+
+=== <Runtime Scenario 1>
+
+
+* _<insert runtime diagram or textual description of the scenario>_
+* _<insert description of the notable aspects of the interactions between the
+building block instances depicted in this diagram.>_
+
+=== <Runtime Scenario 2>
+
+=== ...
+
+=== <Runtime Scenario n>