Hier nun ein paar Grundregeln, die eine gute Dokumentation (egal für welchen Bereich) beachten sollte.
- Sie soll schnell und einfach zu erstellen und zu aktualisieren sein.
- Sie soll auf mögliche Fragen die richtige Antwort liefern.
- Sie soll auf keinen Fall menschliche Interaktionen ersetzen.
1. Allgemeingültige Sachverhalte und wissenschaftliche Erkenntnisse werden immer im Präsens formuliert – egal, ob zur Schilderung der Projektereignisse das Präsens oder Vergangenheitstempora gewählt wurden.Typischer Aufbau
- Projektvorfeld (IST-Analyse) Aufgabenstellung (SOLL-Konzept) Anforderungen.
- Projektziele (SOLL-IST-VERGLEICH)
- Zeitplanung / Meilenstein (Projektmanagement)
- Wirtschaftlichkeit.
- Projektverlauf.
- Ausblick / Folgeaktivitäten.
- Fazit.
- Anlagen / Anhang: (eigentlich Bestandteil der Projektakte) Pflichtenheft. Angebot.
Wie ist eine Projektdokumentation aufgebaut : Im Idealfall umfasst die Dokumentation detaillierte Informationen aus jeder Phase des Projekts: von der Idee bis zum Abschluss. Das bedeutet, dass die Dokumentation bereits bei der Ideenfindung beginnen kann und erst mit dem Abschluss des Projekts enden sollte.
Was beinhaltet die dritte Regel für die Dokumentation
Erkläre Deine Notation (Regel 3) Es ist unstrittig, dass sich bestimmte Informationen mit Bildern besser kommunizieren lassen als mit Text allein. Das gilt für Strukturen (Elemente und deren Beziehungen untereinander) ebenso wie für Abläufe (Folgen von Aktionen mit Alternativen, Wiederholungen, Parallelität).
Was muss alles in eine Dokumentation rein : Qualtitätsmerkmale einer guten Dokumentation
- Vollständig.
- Übersichtlich.
- Verständlich auch für Dritte: Auftraggeber, Nachfolger oder Vertreter.
- Strukturiert.
- Korrekt.
- Nachvollziehbar.
- Objektiv.
- Unveränderbar (mit Änderungshistorie / revisionssicher)
Bericht schreiben – Zeitform
In einem Bericht liegt das Geschehen in der Vergangenheit und ist abgeschlossen. Daher wird der Bericht hauptsächlich im Präteritum, also der 1. Vergangenheitsform, geschrieben.
Ein Bericht steht im Präteritum, denn es wird ja berichtet, was unter welchen Umständen geschah. Falls du in dem Bericht über etwas berichtest, das bereits vor dem Ereignis passierte, musst du die Zeitform Plusquamperfekt verwenden.
Was gehört in einer Dokumentation
Eine Dokumentation kann – neben dem eigentlichen Inhalt – folgende Informationen enthalten:
- eindeutige Zuordnung zu einem Prozess.
- verantwortlicher Prozesseigner.
- Datum und Unterschrift der Änderung.
- Abnahmevermerk des Prozesseigners mit Datum und Unterschrift.
- offizieller aktueller Stand des Dokumentes: Datum und Link.
So schreiben Sie eine Dokumentation
- Eine Dokumentation ist wie jeder andere Text auch in eine Einleitung, einen Hauptteil und einen Schluss aufgeteilt.
- Im Hauptteil teilen Sie dem Leser mit, was Sie zur Lösung des Problems getan haben.
- Der Schluss umfasst, wie bei anderen Textformen auch, das Fazit der Arbeit.
Eine Dokumentation kann – neben dem eigentlichen Inhalt – folgende Informationen enthalten:
- eindeutige Zuordnung zu einem Prozess.
- verantwortlicher Prozesseigner.
- Datum und Unterschrift der Änderung.
- Abnahmevermerk des Prozesseigners mit Datum und Unterschrift.
- offizieller aktueller Stand des Dokumentes: Datum und Link.
Die wichtigsten Anforderungen sind:
- 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 macht gute Dokumentation aus : Gute Technische Dokumentation kombiniert Textinhalte mit Screenshots und Videos und schafft so ein vielseitiges Nutzererlebnis. Bieten Sie dem Nutzer eine Schritt-für-Schritt-Anleitung und ein begleitendes Video, in dem diese in die Praxis umgesetzt wird.
Werden Berichte im Präteritum geschrieben : Bericht schreiben – Zeitform
Dann solltest Du auf die passende Zeitform achten. In einem Bericht liegt das Geschehen in der Vergangenheit und ist abgeschlossen. Daher wird der Bericht hauptsächlich im Präteritum, also der 1. Vergangenheitsform, geschrieben.
In welcher Zeit schreibt man ein Portfolio
Präsens – bei wissenschaftlichen Texten ein Muss
Wer jetzt aber denkt, dass er seine Arbeit in einer Vergangenheitsform schreibt, ist auf dem Holzweg: Für wissenschaftliche Arbeiten ist Präsens die passende Zeitform. Die Gegenwartsform hat sich in der Wissenschaft als übliches Tempus etabliert.
Verwende die Zeitform Präsens und sprich den Leser mit Sie, du oder man an. Teile deine Vorgangsbeschreibung in eine Einleitung, einen Hauptteil und den Schluss ein.In die Einleitung schreiben Sie, was genau die Problemstellung war. Sie geben dem Leser also eine Übersicht über die elementaren Informationen. Im Hauptteil teilen Sie dem Leser mit, was Sie zur Lösung des Problems getan haben.
Was gehört nicht in eine Dokumentation : Unstimmigkeiten und Verdächtigungen gehören nicht in die Dokumentation.