add doc

doc/crapderive.adoc

@@ -0,0 +1,88 @@
+// header file for arc42-template,
+// including all help texts
+//
+// ====================================
+
+= Crapderive
+// 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[]
+
+// configure EN settings for asciidoc
+include::src/config.adoc[]
+
+
+include::src/about-arc42.adoc[]
+
+// horizontal line
+***
+
+
+
+
+// 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. 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[]
+
+

doc/src/01_introduction_and_goals.adoc

@@ -0,0 +1,22 @@
+[[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>_
+|===

doc/src/02_architecture_constraints.adoc

@@ -0,0 +1,5 @@
+[[section-architecture-constraints]]
+== Architecture Constraints
+
+
+

doc/src/03_system_scope_and_context.adoc

@@ -0,0 +1,24 @@
+[[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>**

doc/src/04_solution_strategy.adoc

@@ -0,0 +1,5 @@
+[[section-solution-strategy]]
+== Solution Strategy
+
+
+

doc/src/05_building_block_view.adoc

@@ -0,0 +1,109 @@
+[[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>_

doc/src/06_runtime_view.adoc

@@ -0,0 +1,18 @@
+[[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>

doc/src/07_deployment_view.adoc

@@ -0,0 +1,42 @@
+[[section-deployment-view]]
+
+
+== Deployment View
+
+
+
+=== Infrastructure Level 1
+
+
+
+_**<Overview Diagram>**_
+
+Motivation::
+
+_<explanation in text form>_
+
+Quality and/or Performance Features::
+
+_<explanation in text form>_
+
+Mapping of Building Blocks to Infrastructure::
+_<description of the mapping>_
+
+
+=== Infrastructure Level 2
+
+
+
+==== _<Infrastructure Element 1>_
+
+_<diagram + explanation>_
+
+==== _<Infrastructure Element 2>_
+
+_<diagram + explanation>_
+
+...
+
+==== _<Infrastructure Element n>_
+
+_<diagram + explanation>_

doc/src/08_concepts.adoc

@@ -0,0 +1,22 @@
+[[section-concepts]]
+== Cross-cutting Concepts
+
+
+
+
+
+=== _<Concept 1>_
+
+_<explanation>_
+
+
+
+=== _<Concept 2>_
+
+_<explanation>_
+
+...
+
+=== _<Concept n>_
+
+_<explanation>_

doc/src/09_architecture_decisions.adoc

@@ -0,0 +1,5 @@
+[[section-design-decisions]]
+== Architecture Decisions
+
+
+

doc/src/10_quality_requirements.adoc

@@ -0,0 +1,13 @@
+[[section-quality-scenarios]]
+== Quality Requirements
+
+
+
+
+=== Quality Tree
+
+
+
+=== Quality Scenarios
+
+

doc/src/11_technical_risks.adoc

@@ -0,0 +1,5 @@
+[[section-technical-risks]]
+== Risks and Technical Debts
+
+
+

doc/src/12_glossary.adoc

@@ -0,0 +1,15 @@
+[[section-glossary]]
+== Glossary
+
+
+
+[cols="e,2e" options="header"]
+|===
+|Term |Definition
+
+|<Term-1>
+|<definition-1>
+
+|<Term-2>
+|<definition-2>
+|===

doc/src/about-arc42.adoc

@@ -0,0 +1,16 @@
+:homepage: https://arc42.org
+
+:keywords: software-architecture, documentation, template, arc42
+
+:numbered!:
+**About arc42**
+
+[role="lead"]
+arc42, the Template for documentation of software and system architecture.
+
+Created and maintained by Dr. Peter Hruschka, Dr. Gernot Starke and contributors.
+
+Template Revision: 8.0 EN (based on asciidoc), February 2022
+
+(C)
+We acknowledge that this document uses material from the arc 42 architecture template, https://arc42.org.

doc/src/config.adoc

@@ -0,0 +1,9 @@
+// asciidoc settings for EN (English)
+// ==================================
+:toc-title: table of contents
+
+// enable table-of-contents
+:toc:
+
+// where are images located?
+:imagesdir: ./images