Skip to content

Latest commit

 

History

History
9 lines (7 loc) · 758 Bytes

README.adoc

File metadata and controls

9 lines (7 loc) · 758 Bytes

arc42 Dokumentation

Die Architektur-Dokumentation von jFachwert orientiert sich am Arc42-Template. Als Format wird AsciiDoc verwendet, weil es mit jedem x-beliebigen Editor (und damit auch direkt aus der IDE) erstellt werden kann. Damit kann es wie normaler Source-Code behandelt und zusammen mit dem Source-Code abgelegt und versioniert werden.

Ein weiterer Vorteil von AsciiDoc ist, dass es auch von GitHub unterstützt wird. Damit kann man die einzelnen Kapitel oder den Einstieg über index.adoc über GitHub direkt anschauen, ohne dass man sich auf die Suche nach dem generierten Gesamt-Dokument machen muss.