Entwässerungsbetriebder Stadt Erlangen Vorgaben Dokumentation
Um die Dokumenteimmer auf aktuellen Standzu halten, ist es notwendig, dass alle Änderungenunmittelbarund zuverlässig nachgeführt werden; dies beinhaltet alle Dokumente, d.h. auch alle übergeordneten Dokumentewie:
Änderungslisten ( -ARA od. -ASA / -Anlagenteil / -Ordner )
Übersichtslisten ( -Automatisierung / -Messtechnik / -Antriebe )
Listen ausgegebeneDokumente + Kennzeichnung des Dokuments(z.B.
Achtungsvermerk)
FolgendeOrdnerstruktur ist verbindlichfür jeden Anlagenteil: 1_Automatisierung 0_Uebersichtliste_Automatisierung 1_Einstellwerte_Sollwerte 2_Funktionsbeschreibung 3_Handbuecher 4_Software 6_Symboltabelle 7_Belegungsliste 8_Softwaredesign 9_Prozessbilder_R_I_Schema_Uebersicht s_10_Stammdaten_Dateien 2_Elektroausruestung 1_Schaltplaene 2_Aufbauplaene 3_Schaltplaene_TIF_PDF 4_Klemmenplaene 5_Kabellisten 6_Stuecklisten 7_Erdungsplaene 8_Bauplaene 9_Pruefprotokolle_und_Genehmigungen b_10_Bilder 3_Messtechnik 0_Uebersichtsliste_Messtechnik 4_Antriebe 0_Uebersichtsliste_Antriebe
Folgende Verzeichnis-und Dateinamen-Richtlinie ist verbindlich: Sonderzeichen, wie ?[ ] / \ = + < > : ; „ “ , ! §$% & * ~ # ^° | sind zu vermeiden Umlaute ( ä,Ä/ ö,Ö / ü,Ü ) undßsind zu vermeiden Punkte nur zum Abtrennen der sog. Dateinamenerweiterung, wie .doc, verwenden (d.h. nur ein Punkt pro Dateiname) Steuerzeichen, wie Tabulatorzeichen, Zeilenumbruch sindzu vermeiden; statt Leerzeichen ist der Unterstrich „_“ zu verwenden ! Der Grundfür diese Einschränkung ist der, dassdie Dateinamenmit diversenWerkzeugen verarbeitet werdenmüssen und die angegebenenZeichen dannevtl. eineSonderbedeutung haben. Bei vielen Anwendungen tauchenerst im nachhinein Fehler auf, die durchein konsequentes Anwenden der Richtlinie vermieden werdenkönnen (z.B. Mailanhänge lassen sich nicht öffnen, Dateien lassen sich nichtkopieren oder löschen). Nochgrößer könnendieProbleme beikünftig vermehrten Einsatzvon Unix/Linux-Systemen werden. Hierbeikann esdann zu erheblichem Nachbearbeitungsaufwandbei Datei- und Verzeichnisnamenkommen.
Folgende Namenskonventionfür Dokumentendateien ist verbindlich:
| 1. Stelle | 2. Stelle | 3. Stelle | 4. Stelle | |
|---|---|---|---|---|
| ArtdesDokuments | Firmenname | GenaueTyp- bezeichnung | Klartextbezeichnung | |
| Betriebshandbuch(BH) | auch Betriebsanleitung Betriebshinweise TechnischeDokumentation | z.B.Zentralbaugruppe Messumformer Niveaumessung | ||
| Gerätehandbuch(GH) | auch Aufbaurichtlinien | |||
| Kurzanleitung(KA) | auchTabellenhefte | |||
| Referenzhandbuch(RH) | auchTabellenhefte | |||
| Plan(PL) | auch R+I-Schemata | |||
| Prüfbericht(PB) | BeimehrerenDateienindiesem Registerergänzenmitlfd.Nummer odermitAnlagenteilbzw. Funktionseinheit. | |||
| Liste(Li) | zuergänzenmitbiszuzweifrei wählbarenBezeichnungen,dieden Listeninhaltwiedergeben | |||
| Protokoll(PR) | zuergänzenmitbiszuzweifrei wählbarenBezeichnungen,dieden Listeninhaltwiedergeben |
AuchBedienungsanleitungfüreinen Anlagenteiloderkomplexerer Komponenten.Beimehreren DateienindiesemRegister Funktionsbeschreibung ergänzenmitlfd.Nummerodermit (FB) Anlagenteilbzw.Funktionseinheit.
| Einstellwerte/ Sollwerte(ES) | BeimehrerenDateienindiesem Registerergänzenmitlfd.Nummer odermitAnlagenteilbzw. Funktionseinheit.Bei Zusammengehörigkeitvon Dokumentenmitzusätzlichen Buchstabeninalphabetischer Reihenfolgeergänzen | |||
|---|---|---|---|---|
| Softwaredesign(SD) | BeimehrerenDateienindiesem Registerergänzenmitlfd.Nummer odermitAnlagenteilbzw. Funktionseinheit. | |||
| Aufbauplan(AP) | kannbeiBedarfergänztwerdenum Funktionseinheitoder Klartextbezeichnungder Unterverteilung | |||
| Stromlaufplan(SP) | kannbeiBedarfergänztwerdenum Funktionseinheitoder Klartextbezeichnungder Unterverteilung | |||
| Klemmenplan(KP) | kannbeiBedarfergänztwerdenum Funktionseinheitoder Klartextbezeichnungder Unterverteilung | |||
| Stückliste(SL) | kannbeiBedarfergänztwerdenum Funktionseinheitoder Klartextbezeichnungder Unterverteilung | |||
| Kabelliste(KL) | kannbeiBedarfergänztwerdenum Funktionseinheitoder Klartextbezeichnungder Unterverteilung | |||
| Datenblatt(DB) | kannbeiBedarfergänztwerdenum Funktionseinheitoder Klartextbezeichnungder Unterverteilung | |||
| Technische Beschreibung(TB) | mussergänztwerdenum Klartextbezeichnung | |||
| Pflichtenheft(PH) | mussergänztwerdenum Klartextbezeichnung | |||
| Schulungsunterlagen (SCH) | mussergänztwerdenum Klartextbezeichnung | |||
| Bilder(Photos) (BLD) | mussergänztwerdenum Klartextbezeichnung | |||
| Querverweise(QV) | mussergänztwerdenum Dateinamen |
mussergänztwerdenum Wartungsvertrag(WV) Klartextbezeichnung
| CD(CD) | fertigerFirmendatenträgermussum Klartextbezeichnungergänzt werden | |||
|---|---|---|---|---|
| Software(SW) | mussergänztwerdenum DateinamenundoderKlartext |
Beispiel: BH_Ritz_BR38_Kanalradpumpen_Spuelabwasser.tif