Dokumentation zu einer präsentation schreiben

Beispiel für ein Präsentationsdokument

Präsentation zum Thema: “Schreiben und Editieren modularer Dokumentation: Some Best Practices Yoel Strimling (Comverse) Basierend auf einer gemeinsamen Präsentation mit Michelle Corbin (IBM) auf der…” – Mitschrift der Präsentation:

Schreiben und Bearbeiten modularer Dokumentation: Some Best Practices Yoel Strimling (Comverse) Basierend auf einer gemeinsamen Präsentation mit Michelle Corbin (IBM) auf dem 55 th Annual STC Technical Communication Summit, Philadelphia (Mai 2008)

4 Unter Modularisierung versteht man die Aufteilung eines Textes in diskrete, eigenständige Informationseinheiten, die sogenannten Themen. Modulares Schreiben hilft den Autoren, ihre Dokumentation besser zu organisieren, zu konstruieren und zu schreiben. Modulares Schreiben hilft den Lesern, das Geschriebene besser zu finden, zu nutzen und zu verfolgen. Modulares Schreiben macht Informationen: Leichter zu finden Leichter zu verstehen Leichter zu benutzen

9 Die drei Themenarten Bieten Hintergrundinformationen, die der Leser wissen muss, und erläutern oder beschreiben Konzepte in einem beschreibenden Format Bieten sequenzielle Schritt-für-Schritt-Anweisungen in einem Verfahrensformat Bieten detaillierte erläuternde Informationen in einem strukturierten Nachschlagetabellen- oder Listenformat Konzeptthemen Aufgabenthemen Referenzthemen

Was ist ein Beispiel für eine Dokumentation?

Beispiele sind Benutzerhandbücher, Weißbücher, Online-Hilfen und Kurzanleitungen. Dokumentation auf Papier oder in Papierform ist immer seltener geworden. Die Dokumentation wird häufig über Websites, Softwareprodukte und andere Online-Anwendungen verbreitet.

Was sind die Grundregeln der Dokumentation?

Sie müssen klar, lesbar, knapp, zeitnah, fortschrittlich und genau sein. Enthalten Sie Informationen über Bewertungen, ergriffene Maßnahmen, Ergebnisse, Neubewertungsprozesse (falls erforderlich), Risiken, Komplikationen und Veränderungen.

Welches sind die fünf häufigsten Arten von Unterlagen?

Arten von Dokumentation

Zu den Arten der Systemdokumentation gehören ein Anforderungsdokument, ein Quellcodedokument, eine Qualitätssicherungsdokumentation, eine Softwarearchitekturdokumentation, eine Lösungsanleitung und ein Hilfeleitfaden für fortgeschrittene Benutzer.

Wie man Software-Dokumentation schreibt

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.

  Dokumentation über den 2 weltkrieg

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 Entwicklerdokumentation schreibt

Die Leute sehen sich den Code manchmal gerne an. Sie könnten daran interessiert sein, Fehler im Code zu melden, wenn sie Probleme gefunden haben. Machen Sie es den Leuten, die etwas zum Projekt beitragen wollen, so einfach wie möglich. Ich denke, der Python Guide leistet gute Arbeit mit dem Link zum Code-Teil.

Viele Leute haben die gleichen Probleme. Wenn das immer wieder vorkommt, sollte man wahrscheinlich die Dokumentation oder den Code verbessern, damit die Probleme verschwinden. Es gibt jedoch immer Fragen, die zu Ihrem Projekt gestellt werden, Dinge, die nicht geändert werden können, usw. Dokumentieren Sie diese, und halten Sie sie auf dem neuesten Stand. FAQs sind in der Regel veraltet, aber wenn sie gut gemacht sind, sind sie eine goldene Ressource. Tastypie hat mit seinem “Kochbuch”-Konzept gute Arbeit geleistet.

  Ist der führerschein ein amtliches dokument

Normalerweise haben die Leute Standards dafür, wie sie erwarten, dass Dinge in ihren Projekten erledigt werden. Sie sollten diese dokumentieren, damit die Leute, die den Code schreiben, die Dinge in der Norm des Projekts tun können. Open Comparison leistet in dieser Hinsicht hervorragende Arbeit.

Sobald die Leute herausgefunden haben, ob sie Ihren Code benutzen wollen oder nicht, müssen sie wissen, wie sie ihn bekommen und zum Laufen bringen können. Hoffentlich sollte Ihre Installationsanleitung für den einfachsten Fall nur ein paar Zeilen umfassen. Eine Seite mit weiteren Informationen und Warnungen sollte von hier aus verlinkt werden, falls nötig. Ich denke, dass wir bei Read the Docs in dieser Hinsicht gute Arbeit leisten.

Ideen für die Präsentation von Dokumenten

Ein Dokumentationsstil ist ein Standardansatz für die Angabe von Quellen, die der Autor einer Arbeit konsultiert, abstrahiert oder zitiert hat. Er schreibt Methoden für die Angabe von Referenzen im Text, die Erstellung eines Verzeichnisses der zitierten Werke am Ende der Arbeit und sogar die Formatierung von Überschriften und Rändern vor.

Durch die Angabe von Quellen wird nicht nur die Leistung gewürdigt, sondern der Leser kann auch die von Ihnen herangezogenen Quellen ausfindig machen. Kurz gesagt, der Leser Ihrer Arbeit muss in der Lage sein, die von Ihnen bereitgestellten Informationen sowohl im Text als auch in den angehängten Listen zu verwenden, um die von Ihnen durchgeführten Recherchen nachzuvollziehen.

  Libreoffice fehler beim speichern des dokuments

Jetzt fragen Sie sich wahrscheinlich: “Ja, aber woher weiß ich, wo die Ideen anderer aufhören und meine eigenen anfangen?” Wenn Sie Arbeiten schreiben, die eine Recherche erfordern, sind Sie wahrscheinlich schon lange genug im akademischen Bereich tätig, um zu wissen, dass die einzige gute Antwort auf eine solche Frage lautet: “Gute Frage”.

Ein Grundprinzip der akademischen Forschung, das den freien Austausch von Ideen fördert, ist es, die Quellen zu nennen, denen sie gebühren. Letztendlich müssen Sie selbst entscheiden, welche Ideen Sie für sich beanspruchen können und welche Sie anderen zuschreiben sollten. Vielleicht sollten wir darüber nachdenken, wie wir möchten, dass unsere Arbeit gutgeschrieben wird, und uns daran orientieren.

Esta web utiliza cookies propias para su correcto funcionamiento. Al hacer clic en el botón Aceptar, acepta el uso de estas tecnologías y el procesamiento de tus datos para estos propósitos. Más información
Privacidad