Zum Hauptinhalt springen

Dokumentenarten

Gruppe von Dokumenten mit gleichartigen Eigenschaften - DCC = document kind classification code

Dokumentenart

Ein Dokumentenarten beschreibt eine Gruppe von Dokumenten mit gleichartigen Eigenschaften.

Die Zuordnung zu einem Dokumentenart definiert ein Dokument im Hinblick auf seinen Informationsinhalt, seine Anforderungen an die Dokumentenlenkung und die Darstellungsform.

Typische Dokumentenartenklasse, Hauptklassen​

Dokumententypen nach EN61355-1​

Die Norm EN 61355-1 Klassifikation und Kennzeichnung von Dokumenten für Anlagen, Systeme und Einrichtungen regelt die einheitliche und Hersteller übergreifende Klassifikation und Identifikation von Dokumenten (Dokumentenklasse). Die Norm regelt die Vergabe von Dokumentenartenkennzeichen (engl.: DCC = document kind classification code) für jede Art von Dokumenten. Typische Dokumententypen in Anlehnung an die EN 61355-1 sind u.a.:

A - Dokumentationsbeschreibende Dokumente: Metadaten​

  • AC - Erläuternde Dokumente: Dokumentenbeschreibung, Dokumentationsstrukturplan

B - Managementdokumente​

  • BB - Berichte: Besprechungsbericht, Statusbericht, Technischer Bericht, Schadensmeldung, Montagebericht, Inbetriebsetzungsbericht, Übergabeprotokoll
  • BC - Schriftwechsel: Briefe, Notizen
  • BA - Objektschutzdokumente: Fluchtwegeplan, Notfallanweisung, Brandschutzplan, Lärmschutzplan
  • BT - Schulungsdokumente: Schulungsbeschreibung, Anleitungen, Bedienungshandbücher. Merkblätter, Leitfäden

C - Vertragliche und nichttechnische Dokumente​

  • CA - Anfrage-, Kalkulations- und Angebotsdokumente: Anfrage (AF), Kalkulationsblatt (kaufmännisch), Angebot (AN), Kaufabsichtserklärung, Akzept.
  • CC - Vertragliche Dokumente: Abnahmeprotokolle, Lieferbedingungen (LB), Vertrag (VE).
  • CD - Bestell- und Lieferdokumente: Bestellung (BE), Auftrag (AU), Lieferschein (LS).
  • CE - Rechnungsdokumente: Rechnungen (RE)

D - Dokumente mit allgemeiner technischer Information​

E - Dokumente für technische Anforderungen und Auslegung: Anforderungen​

  • EA - Dokumente über gesetzliche Auflagen: Bauauflagen, Betriebsauflagen
  • EB - Normen und Richtlinien (Guidelines): Refrenzen, Best Practices
  • EC - Technische Spezifikations- / Anforderungsdokumente: Anforderungsspezifikation (Lastenheft), Technische Spezifikation (Pflichtenheft), Verbraucherliste, Komponentenliste Geräteliste der Leittechnik, Messstellen- und Kriterienliste, Motoren- und Verbraucherliste, Prüfspezifikation, Materialspezifikation

F - Funktionsbeschreibende Dokumente​

L - Ortsbeschreibende Dokumente: Pläne​

  • LA - Erschließungs- und Vermessungsdokumente: Vermesserungspläne, Geländeplan.
  • LC - Rohbaudokumente: Bewerhrungsplan, Statikplan. Schalungsplan
  • LD - Dokumente, die Orte an Standorten beschreiben: Anordnungsplan (Standort), Lageplan, Installationsplan (Standort), Installationsschaltplan (Standort), Kabelwegeplan (Standort), Erdungsplan (Standort).
  • LH - Orte in Gebäuden beschreibende Dokumente: Raumplan, Gebäudezeichnung

M - Verbindungsbeschreibende Dokumente​

P - Objektlisten​

  • PA - Materiallisten
  • PC - Stücklisten
  • PD - Produktlisten und Produkttypenlisten
  • PF - Funktionslisten

Q - Qualitätsmanagementdokumente und Sicherheit beschreibende Dokumente​

  • QA - Qualitätsmanagementdokumente: Qualitätshandbuch, Qualitätsplan, Qualitätsaufzeichnungen, Qualitätsleitfaden, Merkblätter, Auditplan, Auditbericht, Korrekturmaßnahmenbericht, Abweichungsbericht, Konformitätserklärung
  • QB - Sicherheitsbeschreibende Dokumente: Sicherheitsstudie, Risikobewertung.
  • QC - Qualitätsnachweisdokumente: Prüfbescheinigung, Materialzertifikat, Testbericht, Mängelbericht.
  • QP - Prozessmanagementdokumente: Prozessbeschreibungen, Verfahrensanweisungen, Arbeitsanweisungen (Work Procedures, Betriebsanweisungen (Operating Procedures)

T - Dokumente zur Beschreibung geometrischer Formen​

  • TA - Entwurfszeichnung
  • TB - Konstruktionszeichnungen
  • TC - Fertigungs- und Errichtungszeichnungen
  • TL - Anordnungsdokumente: Layoutzeichnung

W - Betriebliche Protokolle und Aufzeichnungen​

  • WT - Logbücher, Bedienungsprotokoll, Wartungs- und Änderungsprotokoll, Prüfprotokoll

Die Klassifizierung kann bis zu spezifischen Dokumententypen, z. B. Anwendungsbetriebshandbücher, Installationshandbücher oder Lastenhefte verfeinert werden. Diese Dokumententypen sind zusätzlich durch einen gleichen inhaltlichen Aufbau gekennzeichnet. Dokumentenklassen dienen der Unterscheidung von Dokumenten nach organisatorischen Kriterien. Für die IT-Dokumentation sind beispielsweise IT-Systembetrieb, Systementwicklung und IT-Management sinnvolle Dokumentenklassen, die sich an Aufgabenbereichen, d.h. der Ablauforganisation orientieren. Sofern sinnvoll bzw. erforderlich, können Dokumentenklassen in Unterklassen unterteilt werden. Jede Dokumentenklasse kann grundsätzlich alle Dokumententypen beinhalten. So kann beispielsweise jede Dokumentenklasse Dokumente vom Typ Richtlinie beinhalten.

Die Ausprägung der Information, z.B. als Text, Bild, Ton oder Zeichnung kennzeichnet die Dokumentenart.

Bei den mitgeltenden Dokumenten handelt es sich um Dokumente, die Aussagen/Regelungen enthalten, die für das betrachtete Dokument Gültigkeit besitzen, aber im Dokument nicht näher ausgeführt werden. Typischer­weise sind Rahmendokumente wie beispielsweise Leitlinien oder Richtlinien mitgeltende Dokumente.

Der Begriff der dokumentierten Informationen wurde von der International Organization for Standardization (ISO) 2012 mit den ISO-IEC Directives Part 1 zur Entwicklung von ISO-Normen eingeführt. Er beschreibt aus Sicht der jeweiligen Managementnorm, die vom Unternehmen zu lenkenden und nachzuweisenden (aufrechtzuerhaltenden) Informationen.

Ziel von Dokumentationsmanagement ist die Bereitstellung von anforderungsgerechten Dokumenten, um dadurch einen Wertbeitrag zur Governance zu erbringen. Dokumentationsmanagement umfasst alle Abläufe, Aktivitäten und Funktionen zur Planung, Steuerung und kontinuierlichen Verbesserung des Dokumentenmanagements. Das Dokumentationsmanagement ist damit vom Dokumentenmanagement zu unterscheiden, das sich von der Erstellung und Qualitätssicherung über die Bereitstellung, Nutzung und Aktualisierung bis zur Archivierung und Löschung von zu lenkenden Dokumenten erstreckt.

Dokumentenmanagement beschreibt als Teilbereich von Dokumentationsmanagement die Verwaltung von Dokumenten auf der operativen Ebene. Hierbei kann es sich sowohl um papiergebundene als auch um elektronische Dokumente handeln. Im Fokus stehen die operativen Aktivitäten (Dokumentationsverfahren) im Rahmen des Dokumentenlebenszyklus. In Abgrenzung zum Dokumentationsmanagement werden hier übergeordnete Steuerungs- und Kontrollfunktionen durch das Management nicht betrachtet.

Erläuterungen​

Dokumententypen nach EN61355-1​

Ein Dokumentenartenkennzeichen besteht aus den drei Kennbuchstaben A1, A2, A3, denen ein „&“ vorangestellt wird. Die Angabe des Kennbuchstaben A1 kann entfallen, wenn alle Dokumente aus dem gleichen Bereich stammen. Die Kennbuchstaben A2 und A3 sind für alle technischen Bereiche identisch.

A1 Kennbuchstabe für technischen Bereich​

dokumententyp1

A2 Kennbuchstabe für Hauptklassen​
  1. Metadaten - Dokumentationsbeschreibende Dokumente.
  2. Managementdokumente (Leitlinien, Richtlinien, Strategische Konzepte, Anweisungen, …)
  3. Vertragliche und nicht-technische Dokumente (Angebote, Aufträge, Verträge, Übergabeprotokolle, Abnahmeprotokolle,…)
  4. Dokumente mit allgemeiner technischer Information
  5. Dokumente für technische Anforderungen und Auslegung (Lastenheft, Pflichtenheft, Konzepte)
  6. Funktions-prozessbeschreibende Dokumente
  7. Ortsbeschreibende Dokumente
  8. Objektlisten
  9. Qualitätsmanagementdokumente und Sicherheit beschreibende Dokumente
  10. Dokumente zur Beschreibung geometrischer Formen (Pläne, Zeichnungen)
  11. Betriebliche Protokolle und Aufzeichnungen

dokumententyp2

A3 Kennbuchstabe für Unterklassen​

siehe EN 61355-1 - Link zu WikiPedia.

Dokumententypliste​

  • Aufzeichnungen (Logs, Records)
  • Berichte
  • Bescheide
  • Checklisten
  • Konzepte
  • Merkblätter
  • Pläne
  • Präsentationen
  • Produktinformationen (Produktblätter, Produktbroschüren)
  • Protokolle
  • Richtlinien
  • Trainingsunterlagen
  • Vereinbarungen (Verträge)

Quelle = https://www.slideshare.net/gautamsoman/documentation-types-3647817 https://blog.prototypr.io/software-documentation-types-and-best-practices-1726ca595c7f

  1. Project documentation
  2. project proposal document
  3. software requirements specification
  4. requirements understanding document
  5. HLD
  6. LLD
  7. project plan
  8. release notes
  9. Team documentation
  10. plans and schedules
  11. review reports
  12. status reports
  13. minutes of meetings
  14. checklists
  15. Test documentation
  16. test plan
  17. test cases
  18. issue logs, bug reports
  19. test reports
  20. acceptance test document
  21. System documentation
  22. source code documentation
  23. database documentation
  24. API documentation
  25. User documentation
  26. installation guide
  27. configuration guide
  28. training manual
  29. user manual
  30. administrator guide
  31. troubleshootin guide

Verweise​