004 - IT-Dokumentation on Steroids

IT-Dokumentation, das ungeliebte Kind einer jeden IT-Abteilung, externer Dienstleister und Softwareentwickler

Hintergrund

Ich glaube, hierzu benötigt es keine großen Ausschweifungen. Dokumentation ist generell für viele Menschen ein Alptraum. Ich hingegen muss sagen: ich liebe es, zu dokumentieren!

Sicherlich geschuldet durch meine Pentester-, IT-Auditor-, Forensik- Aktivitäten und jahrzehntelanger Architekturberatung.

Durch das schnelllebige (IT-)Zeitalter konsumieren viele ‘mal kurz’ ein paar Youtube-Videos, GitHub Forks und los geht’s in die Umsetzung, ohne sich groß Gedanken um passende Dokumentation zu machen, geschweige denn ein fundiertes Konzept auszuarbeiten.

Jedoch am Ende des Tages hilft jedem eine gründliche und aktuell-gehaltene Dokumentation!

Spätestens beim nächsten IT-Audit, Out-Sourcing, Out-Tasking oder im IT-Betriebsalltag wird sich gute Dokumentation auszahlen!

Auch im Asset-Management Umfeld oder in der Prozess-Modellierung wird ein Dokumentationsstandard die beste Grundlage für erfolgreiche Projekte und reibungslosen Betrieb sein!

WIE kann ich zur Dokumentation motivieren?

Hier meine Lessons Learned - speziell als ehemaliger IT-Unternehmensgründer:

•  Fokus auf maximale Automatisierung und somit Standardisierung!
•  Alles-ist-Code Ansatz, auch wenn die Hürde zu Beginn hoch erscheint!
•  Klaren Tool-Stack bereitstellen und forcieren - keinen Tool-ZOO erlauben!
•  Für jedes Tool konkrete Vorlagen erstellen
•  Gamification in die Tooling-Landschaft einbauen - spielerisch damit umzugehen fördert Akzeptanz!
•  Tools aktuell halten, damit auch kontinuierlich neueste Features berücksichtigt werden!
•  Für jedes Tool einen Ambassador bestimmen, der immer mal wieder Neuigkeiten und Tips&Tricks aufzeigt!
•  RAG (Retrieval Augmented Generation) auf seine lokalen Daten anwenden - Wiederverwendung, Vermeidung von X-Duplikaten, schnelle Informationsgewinnung!

WO fange ich bloß an?

Die meisten Fehler werden in der Anzahl an unterschiedlichen Tools gemacht. Hier wird häufig argumentiert “es gibt ein besseres Tool für eine spezifische Aufgabe”!

Wir sind in der IT, alles hat Kompromisse und nichts ist perfekt!
… auch keine KI 😅

FALSCH: für jede Aufgabe ein eigenes Tool zu suchen (un-gewartet/gepatcht, unzureichendes Lizenzmanagement …)!

RICHTIG: mit gezielten wenigen Open Source Tools, die sich auch in Automatisierungs-Logiken überführen lassen!

Meine TOOL Empfehlungen?

Hier zusammenfassend meine TOP-Empfehlungen:

• Erstellung von Dokumentation
  • Nutzung von Standard Markdown (ohne proprietäre Erweiterungen wie Atlassian Confluence)
  • So gut wie jedes Wiki oder Text-orientierte Plattform nutzt Markdown in der Basis
  • Maximale Nutzung des freien Microsoft Visual Studio Code Editors mit relevanten Plugins (Bsp. Markdown Preview, D2 Support)
  • Professionelle Darstellung von Abläufen und Prozessen mittels Mermaid
  • ⚠️Standardisierte Ablagestruktur: WO/WIE/WELCHE Dokumentation zu liegen hat (Wildwuchs im Keim ersticken!)
• Erstellung von Diagrammen
  • Für Entwickler und SREs: D2 Declarative Diagramming oder Python Diagrams - gute Beispiele gibt’s hier
  • Für klassische IT-Architekten & ultimativer Visio-Ersatz: Draw.io
• Erstellung von automatisierter AZURE-Dokumentation
  • Mein absoluter Tool-Liebling: Azure Resource Inventory aka ARI
• Erstellung von automatisierter AWS-Dokumentation
  • Workload Discovery on AWS
  • Hier sind einige AWS-Services erforderlich, aber durchaus sehr zu empfehlen in mittel-/großen AWS Multi-Account Umgebungen!
• Agnostisches Asset Inventory
  • Ich habe viele CMDBs aufgebaut & genutzt, aber keines ist so flexibel & automatisierbar
  • Mein gesetzter Standard: CloudQuery
• Aufbau einer Retrieval Augmented Generation (RAG) In-House Plattform
  • Start mit einfachen “lokalen” Mitteln, anhand von NVIDIA ChatRTX: https://www.nvidia.com/de-de/ai-on-rtx/chatrtx/
  • Gezielter Aufbau eines Inhouse-RAGs, wie: PrivateGPT und AnythingLLM

NOCH FRAGEN? SIE SUCHEN HIERZU PRAXISERPROBTE KONZEPTE & IMPLEMENTIERUNGSUNTERSTÜTZUNG?

Kontaktieren Sie mich: gf @ ctopilot . de oder vereinbaren Sie einen Online-Termin!

Erfinde nicht das Rad neu - COPY & INNOVATE. Lerne von den Besten und höre niemals auf zu lernen! Gerald Fehringer