documentation extended with NOTEs and TIPs

oboehm · Feb 5, 2018 · ff3c4b0 · ff3c4b0
1 parent a0ac589
commit ff3c4b0
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 3 deletions.
diff --git a/src/main/asciidoc/de/01_introduction_and_goals.adoc b/src/main/asciidoc/de/01_introduction_and_goals.adoc
@@ -19,7 +19,7 @@ Ich glaube, sie stammt ursprünglich von Herwig Scheidel, mit dem ich zusammen z
 Damals hatten wir eine eigene Fachwert-Bibliothek für den Bankbereich, die Basis des jGEBOS-Frameworks war.
 Es tauchte auch die Idee auf, den Fachwert-Teil des Frameworks als OpenSource auszugliedern, was aber aufgrund diverser Fusionen wieder in Vergessenheit geriet.
 
-Ziel dieser Bibliothek ist es, fuer den deutschsprachigen Raum alle wichtigen Datentypen bereitzustellen, die man sonst immer wieder selbst implementieren muesste.
+NOTE: Ziel dieser Bibliothek ist es, für den deutschsprachigen Raum alle wichtigen Datentypen bereitzustellen, die man sonst immer wieder selbst implementieren muesste.
 
 
 === Aufgabenstellung

diff --git a/src/main/asciidoc/de/04_solution_strategy.adoc b/src/main/asciidoc/de/04_solution_strategy.adoc
@@ -52,5 +52,8 @@ Hier werden Umlaute ausgeschrieben, z.B. `/* Pruefziffer */`).
 Dies hat Auswirkungen auf die Javadoc-Generierung.
 Dies wird aber in Kauf genommen, um Probleme mit falschen Encoding zu vermeiden.
 
+[TIP]
+--
 Bei der Architektur-Dokumentation werden Umlaute akzeptiert.
 Sollte es sich allerdings herausstellen, dass dies auf https://github.com/oboehm/jfachwert/tree/develop/src/main/asciidoc[GitHub] oder http://jfachwert.de/[jfachwert.de] zu Problemen führt, wird auch hier auf Umlaute verzichtet werden.
+--
diff --git a/src/main/asciidoc/de/05_building_block_view.adoc b/src/main/asciidoc/de/05_building_block_view.adoc
@@ -40,10 +40,12 @@ Die einzelnen Klassen sind in fachliche Packages aufgeteilt.
 Das pruefung-Package enthält Klassen zur Validierung und zu verschiedenen Pruefzifferverfahren.
 So enthalten manche Fachwerte wie `IBAN` eine Pruefziffer, um Fehleingaben zu erkennen.
 
-
+[IMPORTANT]
+--
 Wichtige Schnittstellen::
 Jede Klasse hat einen Konstruktor, über den ein Objekt davon angelegt wird.
 Es gibt keine Setter-Methoden, da alle Klassen immutable sind.
+--
 
 
 ==== bank

diff --git a/src/main/asciidoc/de/11_technical_risks.adoc b/src/main/asciidoc/de/11_technical_risks.adoc
@@ -1,6 +1,9 @@
 [[section-technical-risks]]
 == Risiken und technische Schulden
 
-Durch Verzicht auf Logging erschwert sich die Fehlersuche.
+[WARNING]
+--
+Durch den überwiegenden Verzicht auf Logging erschwert sich die Fehlersuche.
 Dies wird dadurch ausgeglichen, dass nur valide Objekte erzeugt werden können.
 Bei fehlerhaften Aufrufen wird eine aussagekräftige Exception geworfen, aus der die Fehlerursache hervorgeht.
+--