Was sollte eine Dokumentation beinhalten?
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.
Was ist wichtig bei einer Dokumentation?
Der wichtigste Tipp ist, dass es sich bei einer Dokumentation um eine fachliche Arbeit mit wissenschaftlichem Charakter handelt. Das bedeutet, eine Dokumentation wird immer sachlich, neutral und präzise geschrieben, Fachausdrücke können und sollen verwendet werden. Zudem ist ratsam, in eher kurzen, aber dafür konkreten Sätzen zu schreiben.
Wie kann man eine umfangreiche Dokumentation erstellen?
Bei einer umfangreichen Dokumentation kann es sinnvoll sein, zunächst eine Inhaltsangabe anzufertigen. Als Anlagen können der Dokumentation dann ein Quellenverzeichnis, ein Glossar mit den verwendeten Fachbegriffen und weitere wichtige Unterlagen wie beispielsweise Skizzen, Tabellen und Fotos oder Rechnungen beigelegt werden.
Welche Unterlagen sollten bei der Dokumentation beigelegt werden?
Als Anlagen können der Dokumentation dann ein Quellenverzeichnis, ein Glossar mit den verwendeten Fachbegriffen und weitere wichtige Unterlagen wie beispielsweise Skizzen, Tabellen und Fotos oder Rechnungen beigelegt werden. Beim Schreiben sollte der Verfasser immer im Hinterkopf behalten, für wen er die Dokumentation schreibt.
Wie sollte die Dokumentation beschreiben werden?
Insgesamt sollte die Dokumentation also den gesamten Weg von der Vorbereitung bis zum Endergebnis nachvollziehbar beschreiben. Quellen dürfen dabei gerne verwendet werden, denn sie werten die Dokumentation zusätzlich auf. Wichtig ist dann aber, die Quellen richtig zu zitieren und in einem Verzeichnis aufzulisten.
https://www.youtube.com/watch?v=ht7yjGb5n2w