diff --git a/docs/src/01_introduction_and_goals.adoc b/docs/01_introduction_and_goals.adoc similarity index 100% rename from docs/src/01_introduction_and_goals.adoc rename to docs/01_introduction_and_goals.adoc diff --git a/docs/src/02_architecture_constraints.adoc b/docs/02_architecture_constraints.adoc similarity index 100% rename from docs/src/02_architecture_constraints.adoc rename to docs/02_architecture_constraints.adoc diff --git a/docs/src/03_system_scope_and_context.adoc b/docs/03_system_scope_and_context.adoc similarity index 100% rename from docs/src/03_system_scope_and_context.adoc rename to docs/03_system_scope_and_context.adoc diff --git a/docs/src/04_solution_strategy.adoc b/docs/04_solution_strategy.adoc similarity index 100% rename from docs/src/04_solution_strategy.adoc rename to docs/04_solution_strategy.adoc diff --git a/docs/src/05_building_block_view.adoc b/docs/05_building_block_view.adoc similarity index 100% rename from docs/src/05_building_block_view.adoc rename to docs/05_building_block_view.adoc diff --git a/docs/src/06_runtime_view.adoc b/docs/06_runtime_view.adoc similarity index 82% rename from docs/src/06_runtime_view.adoc rename to docs/06_runtime_view.adoc index 5cdfbe6..573d234 100644 --- a/docs/src/06_runtime_view.adoc +++ b/docs/06_runtime_view.adoc @@ -37,6 +37,19 @@ There are many notations for describing scenarios, e.g. * __ +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 +---- === === ... diff --git a/docs/src/07_deployment_view.adoc b/docs/07_deployment_view.adoc similarity index 100% rename from docs/src/07_deployment_view.adoc rename to docs/07_deployment_view.adoc diff --git a/docs/src/08_concepts.adoc b/docs/08_concepts.adoc similarity index 96% rename from docs/src/08_concepts.adoc rename to docs/08_concepts.adoc index 4d270a9..569ac0e 100644 --- a/docs/src/08_concepts.adoc +++ b/docs/08_concepts.adoc @@ -50,9 +50,9 @@ image:08-Crosscutting-Concepts-Structure-EN.png["Possible topics for crosscuttin **** -=== __ +=== Domain model -__ +image:UmlDiagram.png["Example UML Diagram"] diff --git a/docs/src/09_design_decisions.adoc b/docs/09_design_decisions.adoc similarity index 100% rename from docs/src/09_design_decisions.adoc rename to docs/09_design_decisions.adoc diff --git a/docs/src/10_quality_scenarios.adoc b/docs/10_quality_scenarios.adoc similarity index 100% rename from docs/src/10_quality_scenarios.adoc rename to docs/10_quality_scenarios.adoc diff --git a/docs/src/11_technical_risks.adoc b/docs/11_technical_risks.adoc similarity index 100% rename from docs/src/11_technical_risks.adoc rename to docs/11_technical_risks.adoc diff --git a/docs/src/12_glossary.adoc b/docs/12_glossary.adoc similarity index 67% rename from docs/src/12_glossary.adoc rename to docs/12_glossary.adoc index 04b40f1..01e71be 100644 --- a/docs/src/12_glossary.adoc +++ b/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 and . -* Potentially more columns in case you need translations. -**** +A table with columns and . -[cols="e,2e" options="header"] -|=== -|Term |Definition +Potentially more columns in case you need translations. -| -| +**** -| -| +[options="header"] +|=== +| Term | Definition +| | +| | |=== diff --git a/docs/src/about-arc42.adoc b/docs/about-arc42.adoc similarity index 98% rename from docs/src/about-arc42.adoc rename to docs/about-arc42.adoc index 6e60e08..69f51bf 100644 --- a/docs/src/about-arc42.adoc +++ b/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 new file mode 100644 index 0000000..91a4ded --- /dev/null +++ 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[] +++++ + +++++ +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 index 5598a0b..87c77c4 100644 Binary files a/docs/images/08-Crosscutting-Concepts-Structure-EN.png and b/docs/images/08-Crosscutting-Concepts-Structure-EN.png differ diff --git a/docs/images/LogoASW.png b/docs/images/LogoASW.png new file mode 100644 index 0000000..d834334 Binary files /dev/null and b/docs/images/LogoASW.png differ diff --git a/docs/images/UmlDiagram.png b/docs/images/UmlDiagram.png new file mode 100644 index 0000000..383f75a Binary files /dev/null and b/docs/images/UmlDiagram.png differ diff --git a/docs/index.adoc b/docs/index.adoc index 8a05a53..bb9bb95 100644 --- 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[] ++++ ++++ -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 deleted file mode 100644 index 334d529..0000000 --- a/docs/src/config.adoc +++ /dev/null @@ -1,9 +0,0 @@ -// asciidoc settings for EN (English) -// ================================== -:toc-title: table of contents - -// enable table-of-contents -:toc: - -// where are images located? -:imagesdir: ./images