Praxisbuch IT-Dokumentation
„Die Dokumentation ist der Sourcecode“, wird oft argumentiert. Wer bei „Dokumentation“ nur an sowas denkt, hat noch ’ne Menge Lernpotenzial. Denn die Dokumentation von Software ist nur ein kleiner Bruchteil von Themen, zu denen im Bereich der IT dokumentiert werden muss. Hier hilft einem das Buch, einen umfassenden Über- und Einblick zu bekommen.
Durch den halbfesten Buchdeckel, der dünner als beim Hardcover ist, kann man mit dem Daumen schnell durchs Buch zappen. Praktisch.
Beim Durchblättern fällt einem sofort die graue Schrift auf, schlechter Kontrast…. Hier braucht man gute Lichtverhältnisse. Und die Schrift ist klein. Bei ca. 460 Seiten mussten diese etwas dünner werden, damit das Buch kein Klotz wird. Dünnere Seiten = durchsichtiger = besser nicht mit schwarz drucken. Soweit nachvollziehbar.
Das Buch beginnt mit den nationalen und europäischen Normen, aus denen Dokumentationspflichten und Dokumentationsanforderungen entstehen. Dann folgen Standards, nach denen die Dokumentation zu erstellen ist. Übrigens: Nicht alles muss zwangsläufig rein als Text dokumentiert werden. Auch (gepflegte) Datenbanken können Teil einer Dokumentation sein. Neben diesen handfesten Infos gibt es auch Tipps, wie man eine Dokumentation pflegt. Was nutzt einem die beste Doku, wenn es parallel mehrere Versionen davon gibt?
Am Ende werden noch Tools vorgestellt. Auf wichtige Funktionen in diesen Tools hingewiesen zu werden, ist hilfreich. Allerdings sind hier ausschließlich kommerzielle Produkte genannt. Gerade für kleine und mittelständische Unternehmen hätte ich mir noch Alternativen aus der OpenSource-Welt gewünscht. Darüber hinaus der Hinweis an den Verlag, dass die abgedruckten Links noch mit QR-Codes versehen werden könnten.
Das Buch zeigt, was möglich ist. Die Autor*innen legen großen Wert darauf, mich nicht wie den Ochs‘ vorm Berg stehen zu lassen, sondern zeigen mir unterschiedlich gut ausgebaute Wege, die in Serpentinen hinauf führen. So kann Jede und Jeder das passende Ziel: „Auf welchen Gipfel und wie hoch möchte ich kommen?“ und den passenden Weg finden: „Autobahn, straight on, Bleifuß oder gemächlicher Fußweg mit hübscher Aussicht?“
Fazit: Brauchbare Hilfestellung für ein leidiges Thema
Themen
- Compliance-Anforderungen
- Rahmendokumentation
- IT-Betriebsdokumentation
- Notfallhandbuch
- Projektdokumentation
- Systemdokumentation
- Service- und Prozessdokumentation
- Anwendungsdokumentation
- Dokumentationsmanagement
Manuela Reiss und Georg Reiss: „Praxisbuch IT-Dokumentation. Vom Betriebshandbuch bis zum Dokumentationsmanagement – die Dokumentation im Griff“. Hanser Fachbuch 2016. 44,99 EUR. ISBN 978-3-446-44599-4.
Gräfin