Beiträge

Was macht eine gute Doku aus?

Dokumentationen sind geliebt und gehasst zugleich. Sie müssen erstellt werden, sie müssen stimmen, sie müssen aktuell sein. Doch was macht eine gute Doku aus? Für wen ist die Dokumentation gedacht und wie wird sie benutzt? Was muss in der Doku enthalten sein? Sie sehen schon, es gibt viele Wege, sich diesem Thema zu nähern. Aus dem Grund machen wir auch eine kleine Serie dazu. Teil befasst sich mit dem Medium, also dem Format der Dokumentation.

Viel Spaß beim Lesen.

Wo stand das wieder und wie ging das noch?

Man findet sie fast überall… auf längst vergessenen Laufwerken, in Ordnern mit dem Namen Archiv… aber auch hoch frequentiert aufgerufen im Intranet, vielleicht sogar auf der Firmenwebsite! Gerade im IT-Sektor ist jeder schonmal in irgendeiner Form mit der ein oder anderen Dokumentation in Kontakt gekommen. Die Bandbreite der in Dokumentationen beschriebenen Themen ist dabei bestimmt so groß, wie die Ausprägungen von Qualität und Mehrwert. Insbesondere durch die von der Digitalisierung geschaffenen Möglichkeiten eröffnen sich die unterschiedlichsten Varianten der Dokumentation.

Auf die Inhalte kommt es an

Wer im Internet recherchiert, findet genügend Templates für die unterschiedlichsten Formate von Dokus. Aber was macht denn eine gute Doku sonst noch aus? Hier legt jeder, je nachdem wie und für was er die Doku nutzt, sie aktualisiert oder verfasst, unterschiedliche Schwerpunkte. Diese Perspektiven unter einen Hut zu bekommen, kann oftmals Schwierigkeiten bereiten. Es macht daher Sinn sich bereits im Vorhinein klar zu werden, welche Aspekte zu einer guten Dokumentation führen. Natürlich hängt das Ganze auch schwer vom zu dokumentierenden Projekt, Produkt oder Service ab. Aus der Erfahrung heraus lassen sich aber gewisse Grundideen für gute Dokumentationen ableiten.

Form folgt der Funktion

Für den Anfang wollen wir einmal auf das Medium eingehen, in dem wir dokumentieren. Eine Dokumentation in Form einer Datei, sei es PDF oder Doc, mit Text, Diagrammen, Tabellen und Bildern haben die meisten schon einmal verwendet oder gepflegt. Vor allem wenn es sich um eine fertig entwickelte Version eines Produktes handelt, macht diese Form Sinn. Sie beschreibt in der Regel einen abgeschlossenen Zustand und wird mit dem Produkt ausgeliefert. Soll jedoch eine Datei als Doku zu einem System/Service dienen, der sich im stetigen Wandel befindet, so stößt man hier bei der Benutzerfreundlichkeit oft an Grenzen. Gerade, wenn mehrere Akteure an der Doku arbeiten, bzw. sie als Nachschlagwerk verwenden, kommt es oft zu Problemen. Die Doku liegt plötzlich in unterschiedlichen Varianten auf verschiedenen Laufwerken und die Arbeit mit und an der Doku wird inkonsistent. Durch die reine Digitalisierung unserer Dokumentation als Datei haben wir in diesem Fall also nicht viel gewonnen.

Online oder offline, das ist hier die Frage.

Digital heißt nämlich nicht gleich digital. Wer hier Abhilfe schaffen möchte und trotzdem nicht auf sein Dokument verzichten will, sollte auf Clouddienste wie „Sharepoint Online“ oder „Google Docs“ setzen. Diese Plattformen ermöglichen das Kollaborieren am selben Dokument und haben integrierte Versionierungsmechanismen. Der Inhalt ist somit stets aktuell und allen Akteuren zugänglich.

Eine weitere Möglichkeit Dokumentationen zu verwirklichen, bieten Webplattformen wie Confluence oder andere Wiki Systeme. Gerade wenn die Doku viele Referenzen sowohl innerhalb als auch nach außen zu weiteren Dokumentationen enthält, lassen sich diese sehr einfach durch Links innerhalb der Wiki Plattform umsetzen. So lassen sich unter anderem Redundanzen vermeiden und der Pflegeaufwand wird insgesamt geringer.

Eine weitere häufig verwendete Form der Dokumentation sind Webseiten. Diese Form eignet sich vor allem, wenn die Doku außerhalb der Firma für den Kunden zur Verfügung stehen soll. Gerade bei der Doku von Frameworks, Libraries oder APIs kann hier eine informative und aktuelle Doku Website die Akzeptanz und Nutzung bei Entwicklern steigern. Sie können neben klassischen Dokumentationsinhalten auch Videos und interaktive Elemente enthalten. Beispielsweise den Aufruf einer REST API direkt aus dem Browser heraus.

Sicher gibt es noch weitere Medien, in denen eine Dokumentation erstellt und gepflegt werden kann. Wir sehen aber bereits an diesen Beispielen, dass schon vor dem Erstellen der Dokumentation die Entscheidung für ein geeignetes Medium eine wichtige Rolle spielt. Für den weiteren Verlauf unserer Serie werden wir weitere Standpunkte und Fragestellungen beleuchten z.B.:

  • Woran erkennen Sie auf den ersten Blick eine gute Dokumentation und was schreckt sofort ab?
  • Was sind die größten Pain Points beim Schreiben oder Aktualisieren einer Doku? Wie vermeiden Sie diese?
  • Für wen ist diese Doku gedacht? Wer wird sie lesen und was wird er/sie in der Doku suchen? Welche Inhalte müssen für wen wie aufbereitet sein?

Vorab würde uns schon interessieren, was für Sie eine gute Doku ist. Schreiben Sie uns doch in die Kommentare, welche Aspekte einer Doku relevant für Sie sind und welche nicht.

Freuen Sie sich auf die kommenden Artikel, wo wir genau diese Punkte im Detail beleuchten werden.

Sie kennen das als Bewerber für eine neue Stelle. Gerade in der Zeit, wenn der Vertrag unterschrieben ist und sie kurz davorstehen, zum ersten Arbeitstag anzutreten. Wie werden die Kollegen sein? wann werde ich wohl meinen Arbeitsplatzrechner bekommen? Habe ich alle Unterlagen geliefert oder mit dabei? Was wird wohl noch fehlen?

Das alles hat nun ein Ende. Mit der Onboarding App von ServiceNow können Sie alles selbst kontrollieren und überwachen. Auch als Arbeitgeber wollen Sie, dass alles reibungslos verläuft und der neue Mitarbeiter vom ersten Tag an produktiv ist. Von der Mitarbeitergewinnung über das Onboarding, bis hin zur Einarbeitungsphase kann der komplette Prozess digital gelebt und erlebt werden.

Vollständig informiert und eingebunden

Als Bewerber / neuer Mitarbeiter, sind Sie vollumfänglich über den gesamten Bewerbungsprozess informiert und eingebunden. Bereits mit der Installation der App werden Sie in den Prozess integriert und willkommen geheißen:

Ab sofort haben Sie alle Informationen für den Bewerbungsprozess in der mobile Onboarding-App Ihres Smartphones und damit alles zentral abgelegt.

Und seinen Sie mal ehrlich, Ihr Smartphone haben Sie immer dabei. Somit haben Sie auch immer alle Unterlagen dabei, denn es braucht keinen Papierkram mehr. Nicht zu verachten, sie brauchen auch Ihre Unterlagen nicht mehr suchen, denn die sind ja ebenfalls in der App abgelegt.

  • immer auf meinem Smartphone dabei
  • keinen Papierkram
  • kein lästiges suchen

Der Bewerbungsprozess ist für Sie transparent. Sie können den Fortschritt mitverfolgen und sind informiert und wissen, was auf Sie zukommt.

Sollten Sie noch Aufgaben haben, wie beispielsweise die Auswahl eines Laptops, erinnert und unterstützt Sie die App. Somit wissen genau, dass Ihr Arbeitsplatz am ersten Tag für Sie vorbereitet ist.

Aufgaben bei denen die App Sie unterstützt – bspw. Auswahl eines zukünftigen Rechners:

Sie fühlen sich von Anfang an integriert, wertgeschätzt und dazugehörig. So können sie sich auf Ihren Job und die Kollegen freuen und einstellen.

Darüber hinaus ermöglicht Ihnen die App, schon jetzt mit dem künftigen Team in Kontakt zu treten. Egal ob Kollege oder Vorgesetzter, Sie können per Chat mit ihnen kommunizieren.

Bei Problemen und Fragen unterstützt Sie der Virtual Agent.

Mit der mobile Onboarding-App sind Sie von Anfang an in das Unternehmen integriert und fühlen sich am richtigen Platz.

Aber nicht nur als Bewerber, sondern auch als Arbeitgeber liefert die App Ihnen gute Dienste.

Alles was für den Bewerber gilt, gilt natürlich auch für Sie als Arbeitgeber. Neben den bereits erwähnten Möglichkeiten können Sie den Bewerbungsprozess mehrerer oder einzelner neuer Mitarbeiter über die gesamte Dauer tracken, effizient gestalten und

die Mitarbeiterbindung bereits in dieser Phase erhöhen.

Mit der mobile Onboarding-App haben Sie alle Daten zentral abgelegt und können somit den Verwaltungs- und Pflegeaufwand stark reduzieren.

Der Bewerbungsprozess ist optimiert und strukturiert und auch abteilungsübergreifend können die Onboarding-Aufgaben Schritt für Schritt abgearbeitet werden.

Sie sind der Lage, Aufgaben in den verschiedenen Abteilungen zu erledigen und somit das Onboarding und den Einarbeitungsprozess effizient gestalten und eine schnellere Produktivität der neuen Mitarbeiter erreichen.

Der Bewerbungsprozess ist nachvollzieh- und messbar und Sie können den Status / Fortschritt der Bewerbungen überwachen.

Aus den möglichen Analysen ist es möglich, gegebenenfalls Maßnahmen zur Optimierung abzuleiten und den Prozess zu verbessern.

Mit der mobile Onboarding-App haben Sie die Möglichkeit, den Bewerbungsprozess zu verfolgen und zu analysieren. Somit wird das Onboarding und der Einarbeitungsprozess einfacher, effizient gestaltet und Sie erreichen eine schnellere Produktivität der neuen Mitarbeiter.

Wir sind uns unserer sozialen Verantwortung bewusst und deshalb unterstützen wir seit Jahren verschiedene soziale Einrichtungen aller Art. Im letzten Jahr haben wir auch den Verein „Rote Nasen Deutschland e.V.“ unterstützt. Heute möchte wir Ihnen die Arbeit der Roten Nasen etwas näher bringen und haben dazu ein Interview mit dem künstlerischen Leiter Reinhard Horstkotte geführt. Er gibt Einblick in das Schaffen und die Auswirkung von Clowns, die bei Menschen in Not zum Einsatz kommen.
Sollten der Verein Sie interessieren und möchten Sie ihn unterstützen, so können Sie das mit einer Spende tun.

Weitere Informationen zum Verein
www.rotenasen.de
www.act4smile.de

Sind Sie fit für die Digitalisierung ?

Reifegradanalyse mit der Hochschule Hof

Corona hat die Defizite im Bereich Digitalisierung – wie mit einem Brennglas – deutlich gemacht und den Handlungsdruck deutlich gesteigert. Dies gilt besonders für den öffentlichen Bereich, aber auch für die meisten privatwirtschaftlichen Unternehmen. Soweit so bekannt.

Häufig fehlt aber noch der methodische Ansatz für eine ehrliche und breit angelegte Bestandsaufnahmen im Unternehmen oder der Behörde. Diese wäre aber notwendig, um darauf aufsetzend die richtigen Prioritäten zu setzen und eine konkrete Roadmap zu erarbeiten.

„Ein weiterer wesentlicher Punkt ist“, so Prof. Dr. Heike Markus, „dass die fachliche Auseinandersetzung mit der Digitalisierung vor dem Einsatz der Technologie kommen muss.

Frau Prof. Dr. Heike Markus, Hochschule Hof

Wir haben dazu, gemeinsam mit der Hochschule Hof und ServiceNow ein Reifegradmodell erarbeitet, das eine schnelle und strukturierte Analyse unterstützt. Das Modell berücksichtigt 7 Dimensionen (Strategie, Führung, Prozesse, Technologie, Mitarbeiter, Daten und Steuerung.) und ist aktuell als Online-Umfrage implementiert.

Die Umfrage wird in kürze differenziert für den öffentlichen Bereich und Privatunternehmen zur Verfügung gestellt und die Teilnahme ist für alle Teilnehmer kostenlos. Die Ergebnisse der Umfragen werden anonymisiert ausgewertet und den  Teilnehmern zur Verfügung gestellt.

Interessiert

Weitere Informationen dazu gibt es in unserem Video und in kürze in einem weiteren Beitrag von uns.

Ansprechpartner