Struktur der Dokumentation
Oft liegt es daran, dass ihnen die Zeit, die Werkzeuge, die Referenzen oder das Wissen fehlen, um es richtig zu machen. Lassen Sie uns also über die verschiedenen Dokumentationsarten und -formate sprechen, über die verschiedenen Möglichkeiten, sie zu erstellen, und über den Prozess, der zur Erstellung einer guten, brauchbaren Dokumentation gehört.
Es gibt viele Arten von Dokumentation, die wir in unserem täglichen Leben verwenden. Es gibt Tutorials, in denen man lernt, wie etwas gemacht wird, Anleitungen, die bei der Lösung von Problemen helfen, technische Referenzen, die einen abgeschlossenen Prozess dokumentieren, und Referenzhandbücher, die im Grunde als eine Art Spickzettel dienen.
Alle diese Dokumentationsarten werden heute in jeder Art von Unternehmen verwendet, aber um nicht alle in einem langatmigen Buch zu verlieren, werde ich sie in allgemeiner Form erörtern und nicht auf die einzelnen Unternehmen eingehen.
Sie sind sich sehr ähnlich, aber auch sehr unterschiedlich. Wie ich bereits erwähnt habe, dienen Tutorials dazu, zu lernen, wie etwas gemacht wird, während ein Leitfaden dazu dient, ein Problem zu lösen. In meiner Welt könnte ich ein Tutorial verwenden, um zu lernen, wie man das neueste E-Mail-Layout programmiert. Dann würde ich eine Anleitung verwenden, um das E-Mail-Programm zu erstellen, mit dem ich die im Tutorial erstellte E-Mail verschicken kann.
Welches Format hat die Dokumentation?
Die Dokumentformatierung bezieht sich auf die Art und Weise, wie ein Dokument auf der Seite gestaltet ist, d. h. wie es aussieht und visuell organisiert ist, und befasst sich mit Dingen wie Schriftauswahl, Schriftgröße und -darstellung (z. B. fett oder kursiv), Abständen, Rändern, Ausrichtung, Spalten, Einzügen und Listen.
Was sind die Beispiele für die Dokumentation?
Beispiele sind Benutzerhandbücher, Weißbücher, Online-Hilfen und Kurzanleitungen. Dokumentationen auf Papier oder in Papierform sind seltener geworden. Die Dokumentation wird häufig über Websites, Softwareprodukte und andere Online-Anwendungen verbreitet.
Welche 3 Arten von Unterlagen gibt es?
Alle Arten von technischer Dokumentation lassen sich in drei Hauptkategorien einteilen: Produktdokumentation, Prozessdokumentation und Vertriebs- und Marketingdokumente.
Dokumentation im Code
Ob Sie nun schon seit Jahren in der Geschäftswelt tätig sind oder gerade Ihre akademische Laufbahn beginnen, das Schreiben von Dokumenten kann einschüchternd sein. Aber keine Sorge: Wenn Sie auf ein leeres Blatt starren und keine Ahnung haben, wie Sie anfangen sollen, sind Sie hier genau richtig. Diese Schritt-für-Schritt-Anleitung wird Ihnen helfen, jedes Schreibprojekt mit Zuversicht anzugehen.
Die Oxford Dictionaries definieren ein Dokument als “ein Stück schriftliches, gedrucktes oder elektronisches Material, das Informationen oder Beweise liefert oder als offizielle Aufzeichnung dient”. Das Schreiben von Dokumenten ist also der Prozess der Erstellung eines schriftlichen Dokuments. Klingt einfach, oder? Schließlich lernen wir alle in der Schule, wie man schreibt, und wir alle wissen, wie man ein Textdokument auf dem Computer öffnet.
Die leere Seite ist der Feind eines jeden Schriftstellers. Selbst Profis starren manchmal stundenlang auf den blinkenden Cursor in der linken oberen Ecke. Entgegen der landläufigen Meinung fördert die Freiheit, die ein leeres Dokument bietet, nicht die Kreativität – sie schüchtert ein. Es gibt tausend Möglichkeiten, sich einem bestimmten Thema zu nähern, eine Million Wege, den ersten Satz zu formulieren. Das Ergebnis ist, dass viele von uns unter dem leiden, was man als “overchoice” oder “choice overload” bezeichnet.
Wie man technische Dokumentation schreibt
Ob es darum geht, wie man ein Dokument speichert, einen Motor startet, ein bestimmtes Werkzeug verwendet oder sogar wichtige Sicherheitsinformationen – Ihre Endbenutzerdokumentation ist ein wichtiger Teil Ihrer Beziehung zu Ihren Kunden.
Die Kunden wenden sich oft an Ihr Support-Team, wenn etwas nicht funktioniert, aber sie rufen auch an, wenn sie etwas einfach nicht herausfinden können. Eine gute Benutzerdokumentation hilft Ihrem Support-Team in zweierlei Hinsicht.
Eine gute Benutzerdokumentation muss nicht nur für die Kunden bestimmt sein. Ihr Produkt-Supportteam kann die Dokumentation nutzen, um Ihre Kunden besser zu unterstützen, wenn diese um Hilfe bitten. Wenn Sie wichtige Teile wie ein Inhaltsverzeichnis oder einen Index einfügen, können sie die benötigten Informationen schnell finden. Und wenn es sich um ein durchsuchbares elektronisches Dokument handelt, ist das sogar noch besser! Wir werden später in diesem Artikel mehr darüber erfahren.
Wie bereits erwähnt, rufen die Leute oft den Support an, wenn sie etwas nicht herausfinden können. Aber wenn die Kunden es selbst herausfinden können, ist die Wahrscheinlichkeit, dass sie Hilfe brauchen, viel geringer. Tatsächlich ziehen es mehr als 70 Prozent der Menschen vor, die Website eines Unternehmens zu nutzen, um Hilfe zu erhalten, anstatt per Telefon oder E-Mail Hilfe zu suchen.
Gute Dokumentation schreiben
Lesedauer: 22 Minuten Technische Dokumentation in der Softwareentwicklung ist der Oberbegriff für alle schriftlichen Dokumente und Materialien, die sich mit der Entwicklung von Softwareprodukten befassen. Alle Softwareentwicklungsprodukte, ob sie nun von einem kleinen Team oder einem großen Unternehmen erstellt werden, erfordern eine entsprechende Dokumentation. Und während des gesamten Softwareentwicklungszyklus (SDLC) werden verschiedene Arten von Dokumenten erstellt. Die Dokumentation dient der Erläuterung der Produktfunktionalität, der Vereinheitlichung projektbezogener Informationen und der Erörterung aller wichtigen Fragen, die sich zwischen den Beteiligten und den Entwicklern ergeben.
Darüber hinaus können Fehler in der Dokumentation dazu führen, dass die Vorstellungen der Beteiligten und der Ingenieure auseinanderklaffen und die vorgeschlagene Lösung nicht den Erwartungen der Beteiligten entspricht. Daher sollten Manager der Dokumentationsqualität große Aufmerksamkeit schenken.
Die Art der Dokumentation, die das Team erstellt, und ihr Umfang hängen von der gewählten Softwareentwicklungsmethode ab. Es gibt zwei Haupttypen: agil und Wasserfall. Beide sind einzigartig, was die begleitende Dokumentation angeht.