Skip to content

Commit 760ae5b

Browse files
committed
some changes
1 parent f6aa0cf commit 760ae5b

7 files changed

Lines changed: 122 additions & 72 deletions

File tree

README.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
:icons: font
22

3+
4+
[role="demo"]
35
== Doc-as-Code Workshop
46

57
Dieses Readme führt durch eine Docs-as-Code Übung.

docToolchainConfig.groovy

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ inputFiles = [
2626
//[file: 'doctoolchain_demo.adoc', formats: ['html','pdf']],
2727
//[file: 'arc42-template.adoc', formats: ['html','pdf']],
2828
[file: '01-arc42/arc42.adoc', formats: ['html','pdf']],
29+
[file: '01-arc42/Fachlich.adoc', formats: ['html','pdf']],
2930
/** inputFiles **/
3031
]
3132

src/docs/01-arc42/Fachlich.adoc

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
:imagesdir: ../images
2+
:jbake-menu: -
3+
// header file for arc42-template,
4+
// including all help texts
5+
//
6+
// ====================================
7+
8+
9+
// configure DE settings for asciidoc
10+
include::chapters/config.adoc[]
11+
12+
= image:arc42-logo.png[arc42] Template
13+
:revnumber: 8.2 DE
14+
:revdate: Januar 2023
15+
:revremark: (basiert auf AsciiDoc Version)
16+
// toc-title definition MUST follow document title without blank line!
17+
:toc-title: Inhaltsverzeichnis
18+
19+
//additional style for arc42 help callouts
20+
ifdef::backend-html5[]
21+
++++
22+
<style>
23+
.arc42help {font-size:small; width: 14px; height: 16px; overflow: hidden; position: absolute; right: 0; padding: 2px 0 3px 2px;}
24+
.arc42help::before {content: "?";}
25+
.arc42help:hover {width:auto; height: auto; z-index: 100; padding: 10px;}
26+
.arc42help:hover::before {content: "";}
27+
@media print {
28+
.arc42help {display:none;}
29+
}
30+
</style>
31+
++++
32+
endif::backend-html5[]
33+
34+
35+
include::chapters/about-arc42.adoc[]
36+
37+
// horizontal line
38+
***
39+
40+
ifdef::arc42help[]
41+
[role="arc42help"]
42+
****
43+
[NOTE]
44+
====
45+
Diese Version des Templates enthält Hilfen und Erläuterungen.
46+
Sie dient der Einarbeitung in arc42 sowie dem Verständnis der Konzepte.
47+
Für die Dokumentation eigener System verwenden Sie besser die _plain_ Version.
48+
====
49+
****
50+
endif::arc42help[]
51+
52+
// numbering from here on
53+
:numbered:
54+
55+
<<<<
56+
// 1. Anforderungen und Ziele
57+
include::chapters/01_introduction_and_goals.adoc[]
58+
59+
<<<<
60+
// 2. Randbedingungen
61+
include::chapters/02_architecture_constraints.adoc[]
62+
63+
<<<<
64+
// 3. Kontextabgrenzung
65+
include::chapters/03_context_and_scope.adoc[]
66+

src/docs/01-arc42/chapters/08_concepts.adoc

Lines changed: 0 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -13,53 +13,9 @@ ifndef::imagesdir[:imagesdir: ../../images]
1313
[[section-concepts]]
1414
== Querschnittliche Konzepte
1515

16-
ifdef::arc42help[]
17-
[role="arc42help"]
18-
****
19-
.Inhalt
20-
Dieser Abschnitt beschreibt übergreifende, prinzipielle Regelungen und Lösungsansätze, die an mehreren Stellen (=_querschnittlich_) relevant sind.
21-
22-
Solche Konzepte betreffen oft mehrere Bausteine.
23-
Dazu können vielerlei Themen gehören, beispielsweise:
24-
25-
* Modelle, insbesondere fachliche Modelle
26-
* Architektur- oder Entwurfsmuster
27-
* Regeln für den konkreten Einsatz von Technologien
28-
* prinzipielle -- meist technische -- Festlegungen übergreifender Art
29-
* Implementierungsregeln
30-
31-
.Motivation
32-
Konzepte bilden die Grundlage für _konzeptionelle Integrität_ (Konsistenz, Homogenität) der Architektur und damit eine wesentliche Grundlage für die innere Qualität Ihrer Systeme.
33-
34-
Manche dieser Themen lassen sich nur schwer als Baustein in der Architektur unterbringen (z.B. das Thema „Sicherheit“).
35-
36-
.Form
37-
Kann vielfältig sein:
38-
39-
* Konzeptpapiere mit beliebiger Gliederung,
40-
* übergreifende Modelle/Szenarien mit Notationen, die Sie auch in den Architektursichten nutzen,
41-
* beispielhafte Implementierung speziell für technische Konzepte,
42-
* Verweise auf „übliche“ Nutzung von Standard-Frameworks (beispielsweise die Nutzung von Hibernate als Object/Relational Mapper).
43-
44-
.Struktur
45-
Eine mögliche (nicht aber notwendige!) Untergliederung dieses Abschnittes könnte wie folgt aussehen (wobei die Zuordnung von Themen zu den Gruppen nicht immer eindeutig ist):
46-
47-
* Fachliche Konzepte
48-
* User Experience (UX)
49-
* Sicherheitskonzepte (Safety und Security)
50-
* Architektur- und Entwurfsmuster
51-
* Unter-der-Haube
52-
* Entwicklungskonzepte
53-
* Betriebskonzepte
5416

5517
image::08-concepts-DE.drawio.png["Possible topics for crosscutting concepts"]
5618

57-
.Weiterführende Informationen
58-
59-
Siehe https://docs.arc42.org/section-8/[Querschnittliche Konzepte] in der online-Dokumentation (auf Englisch).
60-
61-
****
62-
endif::arc42help[]
6319

6420
=== _<Konzept 1>_
6521

src/docs/01-arc42/chapters/09_architecture_decisions.adoc

Lines changed: 8 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -8,36 +8,16 @@ ifndef::imagesdir[:imagesdir: ../../images]
88

99
:toc:
1010

11+
++++
12+
<style>
13+
.td-navbar {
14+
background-color: #e20074 ;
15+
}
16+
</style>
17+
++++
1118

1219

1320
[[section-design-decisions]]
1421
== Architekturentscheidungen
1522

16-
ifdef::arc42help[]
17-
[role="arc42help"]
18-
****
19-
.Inhalt
20-
Wichtige, teure, große oder riskante Architektur- oder Entwurfsentscheidungen inklusive der jeweiligen Begründungen.
21-
Mit "Entscheidungen" meinen wir hier die Auswahl einer von mehreren Alternativen unter vorgegebenen Kriterien.
22-
23-
Wägen Sie ab, inwiefern Sie Entscheidungen hier zentral beschreiben, oder wo eine lokale Beschreibung (z.B. in der Whitebox-Sicht von Bausteinen) sinnvoller ist.
24-
Vermeiden Sie Redundanz.
25-
Verweisen Sie evtl. auf Abschnitt 4, wo schon grundlegende strategische Entscheidungen beschrieben wurden.
26-
27-
.Motivation
28-
Stakeholder des Systems sollten wichtige Entscheidungen verstehen und nachvollziehen können.
29-
30-
.Form
31-
Verschiedene Möglichkeiten:
32-
33-
* ADR (https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions[Documenting Architecture Decisions]) für jede wichtige Entscheidung
34-
* Liste oder Tabelle, nach Wichtigkeit und Tragweite der Entscheidungen geordnet
35-
* ausführlicher in Form einzelner Unterkapitel je Entscheidung
36-
37-
.Weiterführende Informationen
38-
39-
Siehe https://docs.arc42.org/section-9/[Architekturentscheidungen] in der arc42 Dokumentation (auf Englisch!).
40-
Dort finden Sie Links und Beispiele zum Thema ADR.
41-
42-
****
43-
endif::arc42help[]
23+
include::ADRs/ADR042-LLM-Chat.adoc[leveloffset=+1]
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
== ADR-042: Auswahl eines LLM-Chats für Architekturarbeit: OpenAI (ChatGPT)
2+
3+
|===
4+
| Date: h| 2025-05-22
5+
| Authors: h| Ralf D. Müller
6+
| Status: h| Proposed
7+
|===
8+
9+
=== Problem Description and Context
10+
11+
Es soll ein LLM-Chat für Architekturarbeit eingesetzt werden. Es gibt keine spezifischen technischen oder organisatorischen Einschränkungen, und es gibt keine bestehenden Lösungen oder Systeme, die die Entscheidung beeinflussen.
12+
13+
=== Alternative Evaluation (Pugh Matrix)
14+
15+
|===
16+
| Kriterium | Baseline Solution (Mistral AI) | Alternative 1 (OpenAI) | Alternative 2 (Google) | Alternative 3 (Anthropic)
17+
| Kosten | 0 | -1 | -1 | -1
18+
| Performance | 0 | +1 | +1 | 0
19+
| Wartbarkeit | 0 | 0 | 0 | 0
20+
| Komplexität | 0 | 0 | 0 | 0
21+
| Human Eval Benchmark | 0 | +1 | +1 | +1
22+
| **Total Score** | 0 | +1 | +1 | 0
23+
|===
24+
25+
=== Decision
26+
27+
Basierend auf der Pugh-Matrix wird OpenAI (ChatGPT) gewählt, da es in den Kriterien Performance und Human Eval Benchmark besser abschneidet.
28+
29+
=== Consequences
30+
31+
==== Positive Effects
32+
33+
- Verbesserte Performance und bessere Ergebnisse in Human Eval Benchmarks.
34+
35+
==== Risks
36+
37+
- Höhere Kosten im Vergleich zu Mistral AI.
38+
39+
==== Technical Debt
40+
41+
- Keine signifikanten technischen Schulden zu erwarten.
42+
43+
=== Additional Information
44+
45+
- Weitere Informationen zu den Alternativen können auf den jeweiligen Websites gefunden werden.
-50.2 KB
Loading

0 commit comments

Comments
 (0)