Zum Hauptinhalt springen

DM-RL für die Erstellung von Dokumenten

Dokumentationsrichtlinie für die Erstellung von Dokumenten

Bezeichnungen von Dokumenten​

Ein Teil der Dokumentationsrichtlinie umfasst Regelungen zur Benennung von Dokumenten- allg. Regeln für die Bezeichnung von Dokumenten, Namenskonventionen.

Die Bezeichnungen von Dokumenten sollten den Inhalt und den Dokumententyp wiedergeben. Die Dateibezeichnungen müssen folgende Konventionen einhalten:

  • DATUM = Jahr-Monat = 2020-02
  • Objekt = Liegenschaft = SHT
  • Dokumententyp = Plan (Optional)
  • Dokumenteninhalt = A-Bestandsplan
  • Dokumentenformat-PDF im DWG-Format (Optional)
  • Sonstiges

Beispiele

  • 2020-02 SHT Einreichplan im DWG-Format
  • 2023-02 SHT Bauvertrag im PDF-Format
  • 2023-04 SHT Wartungshandbuch

Dateifomate von Dokumenten​

Dokumentationsrichtlinie für Dateiformate beschreiben allg. Regeln für die Speicherung in definierten Dateiformaten.

ZB Im Planbuch im Bauwesen werden folgende Format eingepflegt:

  • PDF-Format mit mind 300dpi-Auflösung und in Farbe für Ausdrucke.
  • DWG-Format für CAD-Programme und Pläne sowie
  • MS-Visio-Formate für die Pflege der Pläne.
  • PNG-Formate oder auch RAW-Format für Baustellenfotos.
  • Office-Formate für Dokumente
  • Markdown-Formate für Verwaltung von digitalen Content (.md)
  • Propritäre Dateiformate, abhängig von der SW-Lösung (ZB. Stromlaufplan, …).

Folgende TAGS zu Dokumentenformate können im CMS (Content Management System) werden angewendet:

  • Dokumentenformat-PDF
  • Dokumentenformat-DWG
  • Dokumentenformat-PNG
  • Dokumentenformat-VISIO
  • Dokumentenformat-Office
  • Dokumentenformat-MD
  • Dokumentenformat-Propritär
  • (Dokumentenformat-others)

dokumenten-_plan-_und_datenformate

Stylesheet von Dokumenten​

In den Dokumentationsrichtlinie sollten Regelungen zur Formatierung und Layout von Dokumenten sowie allg. Regeln und Anforderungen zur Struktur und der Formatierung definiert werden.

Stylesheet-Sprachen sind formale Sprachen in der Informationstechnik, um das Erscheinungsbild von Dokumenten bzw. Benutzeroberflächen festzulegen. Ein Stylesheet ist am ehesten mit einer Formatvorlage zu vergleichen. Grundidee hierbei ist die Trennung von Information und Darstellung.

Kennzeichnung der Dokumenten​

In den Dokumentationsrichtlinie sollen Regelungen zur Klassifizierung von Dokumenten spezifiziert werden. Typische Klassifzierungskritetien umfassen:

  • Informationsklassifizierung - Vertraulichkeits-Klassifizierung
  • Datenschutzklassifizierung nach DSGVO-Kritetrien - Einteilung von personenbezogenen Daten in Schutzbedarfsklassen
  • andere Klassifizierungskritetrien.

Kennzeichnung der Dokumenten​

Dokumenten werden mittels TAGS Dokumentenarten in Anlehnung an Leitfaden – Dokumentation bei Objektübergabe zugewiesen. Mit den Tags können Dokumentenanalysen und Suchen unterstützt werden. Folgende TAGS zu Dokumententypen werden hierzu angewendet:

  • Dokumentenart-Anträge
  • Dokumentenart-Bescheide
  • Dokumentenart-Anzeigen (Fertigstellungsanzeige, Benützungsbewilligung,…)
  • Dokumentenart-Verträge
  • Dokumentenart-Planunterlagen (Pläne, Skizzen, …)
  • Dokumentenart-Projektunterlage (Projektakt, …)
  • Dokumentenart-Prüfunterlagen (Prüfberichte, Prüfbefunde, Prüfprotokolle, Messprotokolle, …)
  • Dokumentenart-Betriebsunterlage (Betriebs-Anleitungen, Wartungshandbücher, Wartungspläne
  • Dokumentenart-Handbücher
  • ...