Namenskonvention: Ein Vorschlag für die sinnvolle Benennung von Dateien

Samstag, 3. Oktober 2015 - 22:49

Namenskonvention, was ist das überhaupt?

Namenskonventionen sind Nomenklaturen, also (freiwillige) Vereinbarungen von Programmierern, Datenbankentwicklern etc., die ein bestimmtes System für die Vergabe von Bezeichnern für Objekte, Variablen und Konstanten einführen, damit anhand der Namen sofort Rückschlüsse auf den Verwendungszweck im Programm / in der Datenbank gezogen werden können.

Quelle: Wikipedia (Abgerufen: 04.10.2015)

​Die Regeln

  1. Keine Sonderzeichen, keine Leerzeichen
  2. Alles in Kleinbuchstaben
  3. Dateinamenlänge beachten
  4. Leerzeichen als "-" (Minus)
  5. Der Name beschreibt den Inhalt
  6. Hierarchischer Dateinamenaufbau
  7. Zahlen mit 0 (Null) vorne auffüllen bis die maximale Anzahl an Stellen erreicht ist, die der Wert annehmen kann

 

Wozu dienen die einzelnen Regeln?

  • Sortierung
  • Gruppierung
  • Filterung
  • Vergleichbarkeit

Nochmal genauer

Regeln 1 und 2: Keine Sonderzeichen, keine Leerzeichen, alles in Kleinbuchstaben

sind rein formal und dienen der gleichen Darstellung und Sortierung auf verschiedenen Systemen (innerhalb verschiedener Betriebssysteme und zwischen Computer und Webanwendung). Auch wenn es heutzutage meist kein Problem ist Umlaute darzustellen, weder im Dateisystem noch in der Adresszeile des Browsers, so ist 1. die Darstellung und Sortierung auf jedem System leicht unterschiedlich und auch 2. die Unterstützung von Sonderzeichen nicht überall vorhanden oder gleich gehandhabt. Deswegen werden Umlaute am besten als ss, ae, oe und ue geschrieben und alle Buchstaben für eine einheitliche Sortierung in Kleinbuchstaben. Es gibt Module die Dateinamen beim Upload automatisch nach diesen Regeln formatieren, das ist zwar gut, aber erstrebenswert ist es die Dateien leicht wiederzufinden; z.B. will ich eine Datei verändern um sie dann auf der Internetseite zu aktualisieren und freue mich wenn die Namen im Web und auf meinem Rechner übereinstimmen und ich sie so leicht über eine automatisierte Suche finden kann.

Regel 3: Dateinamenlänge beachten

Der Dateiname sollte so kurz wie möglich und so lang wie nötig sein und dabei eine Zeichenlänge von 64 Zeichen nicht überschreiten. Auf verschiedenen Systemen sind zwar auch längere Dateinamen zulässig, aber mit 64 ist man auf der sicheren Seite.

Regel 4: Leerzeichen als "-"

Wörter die mit einem Minus getrennt werden, werden von Suchmaschinen - zumindest mit Sicherheit von Google - einzeln indexiert. Schlägwörter die im Dateinamen so getrennt werden, werden also auch von Google gefunden. Da jeder irgendwie mit dem Internet zu tun hat, ist es sinnvoll Leerzeichen plattformübergreifend mit SEO im Hinterkopf gleich zu behandeln – und zwar als Minus.

Regel 5: Der Name beschreibt den Inhalt

und nicht den Verwendungszweck. Es interessiert weder den User im Internet noch den Suchmaschinenbot, ob das Bild das es sieht für den Relaunch xyz gedacht ist, sondern was darauf zu sehen ist, also ​stock--bundestag-frontal-touristen.jpg und nicht verschönerungFür_ArtikelXY.jpg.
Den Empfänger eines Dokuments interessiert es nicht, ob diese Version für ihn bestimmt ist, sondern was er darin erwarten kann, also kochkurs-2015-kapitel-1-zutaten-mehl-01.pdf und nicht DATEIFÜRDICH.pdf.
Alle sollen ohne Vorwissen und ohne die Datei zu öffnen wissen, was sich hinter der Datei verbirgt.

Regel 6: Hierarchischer Dateinamenaufbau

Gemeint ist den Dateinamen nach einer einfachen Baumstruktur aufzubauen, wozu es nötig ist sich zuerst über die Klassifizierung der Informationen über die Datei klar zu werden. Meist habe ich mehrere Dateien zu einem Thema. Ich möchte das an einem Beispiel veranschaulichen:
Angenommen ich gebe einen Kochkurs mit verschiedenen Einheiten der jedes Jahr stattfindet. Dann könnte meine Dateistruktur folgendermaßen aussehen:

  • kochkurs-2015-kapitel-1-zutaten-mehl-01.pdf
  • kochkurs-2015-kapitel-1-zutaten-mehl-02.pdf
  • kochkurs-2015-kapitel-1-zutaten-zucker.pdf
  • kochkurs-2015-kapitel-2-fertigkeiten-ruehren-01.pdf
  • kochkurs-2015-kapitel-2-fertigkeiten-ruehren-02.pdf
  • kochkurs-2015-kapitel-2-fertigkeiten-naschen-01.pdf

Falls es mir wichtig ist verschiedene Teilbereiche (Wrapper) wie z.B. den organisatorischen von dem inhaltlichen Teil zu trennen, kann ich auch zwei "-" einfügen, das sähe dann so aus:

  • kochkurs-2015--kapitel-1--zutaten-mehl-01.pdf

Durch das eingefügte Kapitel kann ich sicherstellen, dass meinen Teilnehmern die Dateien in der Reihenfolge angezeigt werden, in der sie im Kurs behandelt werden.

Ein weiteres Beispiel:
Ich will eine Bilddatenbank aufbauen und habe dazu verschiedene Stockfotos aus teils verschiedenen und teils gleichen Bereichen. Dann macht es Sinn die Stockfotos als solche zu kennzeichen, um sie von Fotos zu unterscheiden die konkret für eine Sache erstellt werden – daraus ergibt sich also bereits der erste Teil des Dateinamens, da das der gleiche gemeinsame Nenner aller meiner Stockphotos ist.
Danach gehe ich stur hierarchisch vor und versehe Fotos auf denen inhaltlich das gleiche abgebildet ist, am Ende mit einer Nummer um sie trotzdem voneinander zu unterscheiden zu können.

  • stock--bundestag-frontal-1.jpg
  • ​stock--bundestag-frontal-2.jpg
  • ​stock--bundestag-frontal-touristen.jpg
  • ​stock--bundestag-vogelperspektive.jpg

Hierarchie gilt auch für Datumsangaben, die manchmal für die inhaltliche Beschreibung einer Datei unerläßlich sind. So ist das Jahr allen Monaten gemein und der Monat allen Tagen des Monats. Daraus ergibt sich also z.B.
2015-12-28--firmenname--teamkonferenz.pdf für eine Teamkonferenz am 28. Dezember 2015. Das Datum am Anfang des Dateinamens führt zu der wahrscheinlich auch so erwünschten chronologischen Sortierung der Protokolle. Auch hier gilt aber "form follows function".

Regel 7: Zahlen mit 0 (Null) vorne auffüllen

Angenommen ich habe im Beispiel mit dem Kochkurs mehr als 9 Kapitel, z.b. 100, dann muss ich für eine korrekte Sortierung die führenden Nullen hinzufügen, da sonst auf Kapitel 1 nicht 2 folgen würde, sondern Kapitel 10. Das sieht dann so aus:

  • kochkurs-2015--kapitel-001--zutaten-mehl.pdf
  • kochkurs-2015--kapitel-002--fertigkeiten-ruehren.pdf
  • kochkurs-2015--kapitel-010--fertigkeiten-eier-aufschlagen.pdf
  • kochkurs-2015--kapitel-011--fertigkeiten-eier-trennen.pdf
  • kochkurs-2015--kapitel-100--essen.pdf

Warum ist das wichtig?

  • Suchmaschinen

    Die Suchmaschine weiß nicht unbedingt was in der Datei gespeichert ist, das trifft v.a. auf Bilder zu. Trotzdem möchte ich aber, dass mein Artikel über die Wattwanderung auch über die Bildersuche gefunden wird. Der Bindestrich wird als Leerzeichen interpretiert, und alle meine Schlagworte werden von der Suchmaschine ausgelesen, und unter Umständen weiß diese sogar wo diese zeitlich einzuordnen ist. Boom Tschacka!

  • Teamarbeit

    Wenn sich alle an die Namenskonvention halten, dann kann ich nach Dateien suchen als hätte ich sie selbst erstellt und benannt. Gibt es schon den Jahresbericht von 2015? Habe ich schon ein Bild um eine Wattwanderung zu illustrieren? Kein langes Suchen mehr und keine doppelte Arbeit.

  • Arbeitserleichterung

    Ich muss nicht jedesmal neu überlegen wie ich meine Datei benenne, sondern halte mich einfach an die Regeln. Ich muss mir meine Dateien nicht einzeln heraussuchen – was zusammengehört steht auch zusammen. Ich kann Dateien über eine einfache automatisierte Suche finden.

Kleiner Ausflug in die Biergartenpsychologie

Disziplin ist wichtig. Denn Disziplin macht Freunde. Jawoll, Freunde. Warum macht Disziplin Freunde? Weil sie am Ende des Tages Arbeit spart, und weil sie die Nerven schont, v.a. die der anderen. Ein Mensch, der arbeiten kann ohne an Alltäglichkeiten wie dem Suchen einer Datei zu scheitern oder mit ihnen viel zu viel Zeit zu verbringen, der kann stressfrei und entspannt arbeiten und sich an dem guten Gefühl erfreuen etwas geschafft zu haben. Der Mensch, der sich freut über seine Mitmenschen, die mitdenken und einem damit das Leben einfach machen, dieser Mensch wird fröhlich sein, hilfsbereit und motiviert selbst das Leben für andere ein wenig schöner zu machen, ein richtig guter Freund eben. So easy.