A'PARI Consulting GmbH - Unternehmensblog

Ein Blog rund um Logistik und IT

  • Startseite
  • Logistik
  • IT
  • Über uns
  • Kontakt
  • Impressum

Gute Dokumentation finde ich gut

6. Februar 2018 von Jürgen Gansen Kommentar verfassen

Gute Dokumentation finde ich gut. Erst kürzlich habe ich mich wieder einmal mit MS-Excel beschäftigt. Werte aus unterschiedlichen Dateien und darin beinhalteten Tabellen sollten zusammengestellt, bearbeitet und die daraus gewonnenen Erkenntnisse in einer ersten Übersicht grafisch aufbereitet werden.

Es ist schon beeindruckend, was einem dieses Standardwerkzeug mit weltweitem Verbreitungsgrad alles an Möglichkeiten bietet.

Allerdings bringt mich bei aller Begeisterung für das Werkzeug an sich die offizielle Dokumentation gerne zur Verzweiflung.

Gute Dokumentationen müssen Lösungen aufzeigen

Es ist nicht so, dass die existenten Befehle nicht super beschrieben wären und durch praktische Beispiele deren Anwendung recht schnell klar ist. Es ist vielmehr so, dass ich die relevanten Befehle nicht so einfach finde.

Grund dafür ist meine Suche, die Lösungen für Aufgaben- und Problemstellungen sucht und als Ergebnis den Vorschlag potentiell anwendbarer Befehle erwartet. Eine Dokumentation, die schöne Lösungen beschreibt und mir damit die Möglichkeit gibt, passende Probleme dafür zu finden, hilft  eben nur sehr bedingt.

Grundregel der menschlichen Kommunikation: Der Empfänger entscheidet, ob und wie eine Botschaft ankommt

Dafür muss sich der Schreiber in den Anwender hineinversetzen

Mir ist bewusst, dass es Dokumentationsnotwendigkeiten gibt, bei denen man keinen direkten Einfluss auf deren Art und Umfang hat. Auch ist klar, nicht alle Suchmuster und Fragestellungen potentieller Anwender abdecken zu können.

Dennoch gibt es aus meiner Sicht einen großen Nutzen für Dokumentation, wenn sich diese nicht am Schreiber, sondern am Leser und Anwender orientiert.

In der Kürze liegt die Würze

Was bringt mir eine „tonnenschwere“ Dokumentation die jeden potentiellen Anwender abschreckt, da er sich in ihr nicht zurecht findet. Was hilft es auf Seite 2.936 im Absatz 3 Schrägstrich 4 nachweisen zu können, dass es aufgeschrieben ist, wenn der, der es beachten soll nicht zum Lesen dieser Stelle gelangen kann.

Sagt ein Bild manchmal mehr als ein Roman voll prosa? Hilft eine mindmap mehr als ein ausformuliertes Protokoll?

Setzt man sich bei der Erstellung und Bereitstellung einer Dokumentation mit den nachfolgenden Fragen so auseinander, dass man zufriedenstellende Antworten findet, ist viel erreicht und Dokumentation nicht nur Kostentreiber, sondern auch Nutzenstifter.

  • Wofür werden Anwender die Dokumentation verwenden? Wie werden sie diese Dokumentation anwenden bzw. mit welchen Strategien werden sie darin suchen um zu finden?
  • Wird Ihnen das, was sie dann finden, ausreichende Antworten auf die Fragen aus der Suche geben?

Gerade in der heutigen Zeit, in der Veränderungen mit rasender Geschwindigkeit stattfinden und Softwareanpassungen und deren Produktivsetzung agil (Agil ist nicht undokumentiert) und in kurzen Zeitintervallen erfolgen, muss Dokumentation kurz, prägnant und treffsicher Auskunft über das aktuelle „wie“ geben können.

 

 

Kategorie: Blog Stichworte: agile Softwareentwicklung, Dokumentation, Projektmanagement, Softwareentwicklung, User

Jürgen Gansen

Über Jürgen Gansen

Ich bin Management Consultant bei A’PARI Consulting GmbH mit den Schwerpunkten Logistik- und IT-Beratung.

Empfohlene Beiträge

Sicherheitsupdates nerven…oder?

Jeder von uns hat das schon mal erlebt: Man will nur schnell seine E-Mails abrufen oder eine wichtige Präsentation ausdrucken, doch was passiert? Nichts! Alles ist sehr zäh, der Computer scheint nicht mehr zu reagieren. Was passiert da gerade? Ach ja, es werden zentral Sicherheitsupdates im Netzwerk verteilt, die sich gerade im Hintergrund installieren. Doch […]

Gegen die Anwesenheitskultur

An Arbeit fehlt es uns nicht. Nach Aussagen des DGB arbeitet jeder dritte vollbeschäftigte Mitarbeiter mehr als 45 Stunden/Woche, jeder sechste sogar mehr als 48 Stunden. Der DGB zieht daraus den  Schluss: Arbeitnehmer sollen ihre Arbeitszeit flexibler als bisher gestalten können. Dafür sind aber keine neuen Gesetze und Verordnungen notwendig. Ein Hauptproblem besteht vielmehr darin, dass […]

Pendlerexpress – Die Dienstwagen-Fahrer auf deutschen Autobahnen

Wir alle sind mit unseren Dienstwagen viel unterwegs in unseren Jobs. Überregionale Aufgabenstellungen beim Arbeitgeber, Kundenbesuche im ganzen Land oder Wochenendpendler, die vom Arbeitsplatz oder Dienstsitz jeden Freitag nach Hause fahren und am Montagmorgen wieder zur Arbeit. Also könnte man doch annehmen, dass wir alle erfahrene Autofahrer sind. Oder doch nicht?

Schreibe einen Kommentar Antworten abbrechen

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.

Time limit is exhausted. Please reload CAPTCHA.

Social Media

Xing Google+ Button RSS Website

Letzte Artikel

  • Mobile Endgeräte – Teil der Digitalisierungstrategie
  • Im Störfall nicht parken!
  • Von altem, zum neuen Lager – Umzug… nur in groß
  • Fahrer für selbstfahrende LKW gesucht
  • TMS – Do it yourself?

Stichworte

agiles Projektmanagement Change Management Cloud Cloud Computing CRM Datenqualität Digitale Transformation Digitalisierung Gesamtprozessdenken Industrie 4.0 Informationssicherheit Innovation ISIS12 ISO27001 IT-Infrastruktur IT Sicherheit Komplexität KPI Notfallmanagement Projektmanagement Prozesse Prozesseffizienz Prozesskosten Prozessmanagement Prozessoptimierung Prozessreifegrad Risikomanagement Sicherheitsmanagement Software-Einführung Softwareanbieter Softwareanforderungen Softwareauswahl Softwareeinführung Speditionssoftware Standardprozesse TMS TMS Auswahl Transport Management System Umsetzung Vertrieb Veränderung Veränderungen Veränderungsmanagement Vorstellung Ziele

Letzte Kommentare

  • Heriberr Herzig bei Mobile Endgeräte – Teil der Digitalisierungstrategie
  • Tine bei Fahrer für selbstfahrende LKW gesucht
  • wir-lieben-google-adwords bei Platooning – der bessere Zug?
  • Hoppe bei Aktuelle Marktübersicht über Transport Management Systeme (TMS) im Landverkehr – mehr Anbieter, mehr Handlungsoptionen
  • Michael Hötte bei Aktuelle Marktübersicht über Transport Management Systeme (TMS) im Landverkehr – mehr Anbieter, mehr Handlungsoptionen

Archiv

© Copyright 2017 A'PARI Consulting GmbH · Datenschutzerklärung