Wissensmanagement in der Architekturarbeit

Wissensmanagement in der Architekturarbeit, Teil 5

Table of Contents 1. Abhängigkeiten der Dokumente darstellen 1.1. Das Abhängigkeitsnetz aus der Bibliographie und dem Quellcode automatisiert generieren 1. Abhängigkeiten der Dokumente darstellen 1.1. Das Abhängigkeitsnetz aus der Bibliographie und dem Quellcode automatisiert generieren Ein weiterer Vorteil der Bibliographie und der Arbeitsweise mit AsciiDoc ist die Möglichkeit die Dateien automatisch zu parsen. So kann man relativ einfach einen Abhängigkeitsbaum der erstellten und zitierten Dokumente generieren lassen. Neben einer einfachen Listen-Darstellung in HTML/PDF kann man den Abhängigkeitsbaum auch als Graphen visualisieren lassen. Hierzu bietet sich dann GraphViz an, das seit über 30 Jahren erfolgreich Graphen für große und kleine Projekte generiert und auch von PlantUML oder AsciiDoc genutzt wird.

Mittwoch, 7. Mai 2025 | 3 Minuten Lesen

Wissensmanagement in der Architekturarbeit, Teil 4

Table of Contents 1. Eine Volltextsuchmaschine mit Recoll einrichten 1.1. Suchoptionen 1.2. Exkurs: PDFs ohne Text mit OCR durchsuchbar machen 1. Eine Volltextsuchmaschine mit Recoll einrichten Eines der häufigsten Probleme mit organisch gewachsenen Dokumentenstrukturen ist es, Daten wiederzufinden. Die Fragestellung ist hier, wie finde ich Dokumente, die eine bestimmte Zeichenkette enthalten? Dafür gibt es verschiedene Lösungsmöglichkeiten. Das Kommandozeilenwerkzeug ´pdfgrep´ ist in der Lage, durch PDF-Dateien zu greppen und liefert so das entsprechende Dokument und die Funstelle im Dokument zurück. Es ist aber nicht in der Lage z.B. durch Word, Excel oder Powerpoint-Dokumente zu suchen.

Dienstag, 6. Mai 2025 | 7 Minuten Lesen

Wissensmanagement in der Architekturarbeit, Teil 3

Table of Contents AsciiDoc in einer Gitlab CICD-Pipeline bauen Gitlab-Releases zur Freigabe von Dokumenten nutzen AsciiDoc in einer Gitlab CICD-Pipeline bauen Mit der .gitlab-ci.yml aus [sourcec] lassen sich Jobs konfigurieren, die AsciiDoc u.a. nach HTML und PDF konvertieren. Die Jobs werden nur getriggert, wenn sich .adoc-Dateien ändern, die Pipeline kann failen und die Artefakte werden für 1h unter dem Verzeichnis Output amgelegt. Für die Konvertierung wird der offizielle AsciiDoctor-Container genutzt. Asciidoctor selbst erhält dann einige Optionen übergeben.

Dienstag, 6. Mai 2025 | 11 Minuten Lesen

Wissensmanagement in der Architekturarbeit, Teil 2

Table of Contents Die BibTeX-Bibliographie als zentrale Datenquelle Die BibTeX-Grammatik Der Workflow mit der Bibliographie Die Bibliographie mit Perl aufbereiten Ein zentrales Glossar samt Stichwortverzeichnis pflegen Die BibTeX-Bibliographie als zentrale Datenquelle Idealerweise wären alle internen Dokumente in der eAkte enthalten und mit einem Aktenzeichen versehen. Da dies nicht der Fall ist, pflegen wir eine eigene Bibliogrpahie. Dies führt unter anderem dazu, dass wir mit dem Bibkey einen eigenen Primärschlüssel für jedes Werk bekommen, eine Aufgabe die eigentlich das Aktenzeichen erfüllen würde. Wenn jedes Dokument ordnungsgemäß in der eAkte samt Aktenzeichen hinterlegt wäre.

Donnerstag, 1. Mai 2025 | 18 Minuten Lesen

Wissensmanagement in der Architekturarbeit, Teil 1

Die Anforderungen In der Architekturarbeit werden relativ viele Dokumente (Konzepte, Richtlinien, Architecture Decision Records) verfasst und auch verarbeitet, d.h. wir zitieren oder verweisen z.B. sehr häufig auf Sicherheitsrichtlinien wie die Anweisung zur Transportverschlüsselung. Wir möchten die dazu notwendigen Arbeitsschritte vereinfachen und mit dem bereits etablierten Arbeitsmodell verbinden. Dieses basiert auf einem zentralen Sourcecodemanagementsystem, in dem Quellcodedateien gepflegt werden. Die Betriebsteams nutzen hierzu Gitlab zum einen als verfügbares Sourcecodemanagementsystem, um die Quellcodedateien entsprechend zu versionieren und die verschiedenen Autoren und Entwicklungsstände zu managen. Zum anderen bietet Gitlab mit der integrierten CI/CD-Pipeline vielfältige Automatisierungsmöglichkeiten.

Donnerstag, 24. April 2025 | 13 Minuten Lesen