Welche arten von dokumentationen gibt es?
Gefragt von: Rosalinde Mann | Letzte Aktualisierung: 13. Juni 2021sternezahl: 5/5 (19 sternebewertungen)
- Programmierdokumentation (Inline Source Documentation) ...
- Methodendokumentation. ...
- Schnittstellendokumentation. ...
- Technische Dokumentation. ...
- Benutzerdokumentation („Handbuch“)
Welche Arten einer Dokumentation gibt es?
- Die Geschichtsdokumentation. Die Geschichtsdokumentation erklärt geschichtliche Geschehnisse anhand von Archivmaterial, um die Richtigkeit der im Film gezeigten Fakten zu unterstreichen. ...
- Direct Cinema. ...
- Die Biographie-Doku. ...
- Der investigative Dokumentarfilm. ...
- Die Mockumentary.
Was beinhaltet eine Dokumentation?
Unter Dokumentation versteht man die Nutzbarmachung von Informationen zur weiteren Verwendung. Ziel der Dokumentation ist es, schriftlich oder auf andere Weise dauerhaft niedergelegte Informationen (Dokumente) gezielt auffindbar zu machen.
Warum Software dokumentieren?
Viele Software-Projekte werden nicht zu Ende geführt oder können nicht weiterentwickelt werden. Der Grund liegt meistens nicht am Programmier-Code selbst, sondern an der fehlenden Dokumentation der Entwicklung. ... Dieser Aufwand kann mit einer guten Dokumentation vermieden werden.
Was ist eine entwicklerdokumentation?
Was macht eine gute Entwicklerdokumentation aus: Sie ist konsistent und vollständig und beinhaltet keine Überschneidungen oder veralteten Inhalte. Sie ist modular, themenorientiert, bietet Verknüpfungen zwischen verwandten Themen und eine Suche über Volltext oder Metadaten.
Beobachtungsformen - Welche Formen der Beobachtung gibt es? | ERZIEHERKANAL
17 verwandte Fragen gefunden
Was ist eine Methodendokumentation?
Die Methodendokumentation enthält Inhalte auf der „Meta-Ebene“, sprich: Algorithmen, Flussdiagramme, technische, wissenschaftliche oder kaufmännische Hintergründe der Software. Die Methodendokumentation geht dabei weniger auf die Details der Programmierung ein, sondern legt, wie der Name sagt, die Methoden fest.
Was ist ein entwicklerhandbuch?
Ein Entwicklerhandbuch baut prinzipiell auf DV- Umsetzungskonzepte – welche im Rahmen von Projekten erstellt werden – auf und beschreibt die Anwendung aus Sicht des Entwicklers, deren Spezifika sowie deren Ansiedlung in der jeweiligen Systemwelt.
Wie sieht eine gute Dokumentation aus?
Die Dokumentation sollte alle wichtigen Informationen erhalten, die Sie den Lesern zeigen wollen. Sie stellt einen Sachverhalt dar und ist einem Protokoll nicht sehr unähnlich, auch wenn eine Dokumentation viel mehr Informationen enthält. ... Sie geben dem Leser also eine Übersicht über die elementaren Informationen.
Wie muss eine technische Dokumentation aussehen?
Struktur. Die Technische Dokumentation muss logisch gegliedert und strukturiert sein. Um die Handhabung zu erleichtern, werden bestimmte Dokumente in Gruppen thematisch oder analog zur Struktur des Erzeugnisses zusammengefasst und mit modular aufgebauten Dokumentenlisten und Inhaltsverzeichnissen verwaltet.
Wer macht was Matrix Technische Dokumentation?
Die Was-macht-wer-Matrix
So sieht der Redakteur, welche Informationen für die einzelnen Handlungen benötigt werden und kann diese mit den Eigenschaften der Zielgruppen abgleichen. Dies geschieht meist über eine Tabelle. Durch die Matrix können eine oder mehrere Anleitungen zielgruppengerecht erstellt werden.
Warum sind Dokumentationen wichtig?
Das Wesen der Dokumentation besteht darin, Informationen jeglicher Art zur Verwendung in der Zukunft aufzubereiten, zu strukturieren und zu konservieren. Dokumentationen spielen speziell auch in privatwirtschaftlichen, auf Gewinn ausgerichteten Unternehmen eine wichtige Rolle. ...
Welche Bereiche erfasst die medizinische Dokumentation?
Die patientenbezogene Dokumentation
-maßnahmen, die in Form der Krankengeschichte vor allem demographische Perso- nendaten, anamnestische Angaben, Befunde, diagnostische und therapeutische Pro- zeduren, Diagnosen, Therapiehinweise und Prognosen des medizinischen Einzelfalls wiedergibt.
Was versteht man unter medizinischer Dokumentation?
Ziel der Medizinischen Dokumentation ist geordnete Information und Wissen über Krankheitsbilder und Behandlungsmethoden (Typen) und für die individuellen Fälle einzelner Patienten (Instanzen) so zu ordnen, dass die medizinische Versorgung im weitesten Sinne unterstützt werden kann.
Welche Pflegedokumentationssysteme gibt es?
Diese Bereiche sind: • Stammdaten, • Pflegeanamnese/Informationssammlung inkl. Erfassung von pflegerelevanten Biografiedaten, • Pflegeplanung, • Pflegebericht, • Leistungsnachweis. Das Dokumentationssystem ist in Abhängigkeit von bestehenden Pflegeproblemen im Rahmen der ver- einbarten Leistungen ggf. zu erweitern.
Was muss man bei einer Dokumentation beachten?
- Zeitnahe Dokumentation.
- Dokumentenechter Stift (Kugelschreiber)
- Angabe von Datum und Uhrzeit.
- Wertfreie und möglichst objektive Formulierungen.
- Leserliches Durchstreichen bei fehlerhaftem Eintrag (Das Durchgestrichene muss noch zu lesen sein)
Was ist eine schriftliche Dokumentation?
Bei einer schriftlichen Dokumentation handelt es sich um eine Aufzeichnung, die einen bestimmten Vorgang oder Gegenstand dokumentiert, also schriftlich festhält.
Wie man richtig dokumentieren?
- Regel 1: Sofort dokumentieren. Jetzt muss man natürlich zugeben, dass sofortige Dokumentation tatsächlich auch den Arbeitsfluss stören kann. ...
- Regel 2: Fasse dich kurz und schreibe in Aufzählungspunkten. ...
- Regel 3: Gib gute Erklärungen und Beispiele.
Was ist eine systembeschreibung?
In der Systembeschreibung zeigt sich der Problemraum des Produktes. Dieser Teil der Dokumentation ist das Abbild der Realität, die Wirklichkeit aus Sicht der Nutzer des IT-Systems. Je mehr ein Team über die Welt weiß, in dem die Software eingesetzt wird, desto besser wird die Lösung.