eCommerce Entwickler Blog

Der Entwickler Blog enthält verschiede Lösungsansätze für Fehler und Bug aus dem eCommerce Umfeld. Hier berichten Entwickler über ihre Erfahrungen und teilen ihre Lösungswege.

Dateinamen: Die beste Möglichkeit, Ordnung im Datenchaos zu halten!

Im Team zusammen zu arbeiten ist nicht immer leicht, auch alleine kann man nach einiger Zeit den Überblick verlieren.

Daher gibt es hier nun den ultimativen Guid um Ordnung im Dateinamenchaos zu bringen.

Als erstes ist es sehr wichtig die Konsistenz zu wahren, damit ist gemeint, dass sich jeder an die besprochenen Konventionen hält und jeder neue Mitarbeiter korrekt und sicher eingearbeitet wird.

 

Fangen wir mit dem grundlegenden Aufbau an.

  1. Optional: Sequenzierung
  2. Projektname: Hier sollte der Name des Projektes stehen. Im ersten Schritt völlig klar. Aber was muss man beim Projektnamen beachten? 
    Ganz einfach, der Projektname sollte für jeden klar sein und sollte am besten mit wenig Zeichen das Projekt korrekt beschreiben, Beispiel: wmdk_website.
  3. Ort: Bei Ort ist immer die Frage ob es benötigt wird, beim Programmieren könnte alternativ das Team oder der Autor benannt werden oder auch ganz weggelassen werden.
  4. Thema: das Thema ist in unserem Beispiel die Kussin Firmenseite. Im Programmierbereich wäre es z.B. ein Template für die Startseite. Dann wäre die Bezeichnung wmdk_website_startseite korrekt.
  5. Typ: Bezeichnung der Datei wofür diese benutzt wird.
  6. Versionsnummer: Versionsnummer der Arbeit
  7. Datum: Erstellungsdatum, wenn man eine Zeitlich Chronologische Auflistung benötigt dann sollte das Datum als erstes auftauchen.
  8. Dateiendung: z.B. .js, .css, .jpg

Allgemein kann man sagen das es nicht immer zwingend Notwendig ist, dass alle Punkte in der Dateibenennung aufgenommen werden. Man sollte sich am Anfang aber einmal richtig Gedanken machen, welche Punkte man benötigt. 

 

Weitere Tipps für Dateinamen:

Für das Datum gibt es 2 gute Möglichkeiten YYYYMMDD oder YYYY-MM-DD, dadurch werden die Dateien chronologisch korrekt angezeigt.


Am besten sollten Dateinamen nicht zu lang sein. Bei zu langen Dateinamen kann es passieren das einige Programme Probleme machen.


Spezielle Zeichen werden kategorisch ausgeschlossen, dazu zählen: ~!@#$%^&*()‘`´,[]{}§“|zusätzlich werden noch die Deutschen Sonderzeichen wie äöüß ausgeschlossen dazu gibt es jeweils alternativen wie ä=ae ö=oe ü=ue ß=ss. Hintergrund ist, dass es bei der Nutzung immer zu Problemen kommen kann die viel Arbeitszeit bei der Fehlerbehebung verursachen.


Für die optionale Sequenzierung gibt es noch zu beachten das die Dateien wie folgt beschriftet werden müssen 001, 002, … 010, 011 … 100, 101, etc. dadurch ist gegeben das die Reihenfolge der Dateien immer korrekt ist.


Es sollten bei den Dateinamen keine Leerzeichen benutzt werden, einige Programme kommen nicht damit klar. Folgende Trennmöglichkeiten stehen zur Verfügung:

Unterstrich z.B. wmdk_website.xxx

Bindestrich z.B. wmdk-website.xxx

Keine Trennung (weniger zu empfehlen da unübersichtlich) z.B. wmdkwebsite.xxx

Binnenmajuskeln, wo bei jeder „Kategorie“ der erste Buchstabe groß geschrieben wird: WmdkWebsite.xxx

Aus Erfahrungswerten heraus empfehlen wir im punkto Leserlichkeit auf einen Mix zwischen Unter- und Bindestrichen zu variieren, dies fördert die Leserlichkeit, Dies ist ein kleines Beispiel:

wmdk_website_2099-11-11


Nach dem wir nun wissen wie wir eine Datei korrekt beschreiben machen wir doch ein Beispiel:

wmdk_website_startsite_tpl_v01_2099-12-18.html

Diese Datei ist also für die Firma Kussin, das Projekt Website, mit dem Thema Startseite, als Template, in der ersten Version am 18.12.2099 erstellt worden.

 

Wenn man einige Dateien beisammen hat kann es Sinn machen eine Readme zu schreiben, so dass auch externe Kollegen schnell zu den gewünschten Dateien finden.

 

Kommunikation ist auch hier alles!
Wenn sich alle abgesprochen haben, können kaum Probleme auftauchen.

 

Wir wünschen fleißiges Datei benennen! 

Credits:

Haben Sie Fragen, Wünsche oder Anregungen?
Dann können Sie uns über unser Kontaktformular kontaktieren.

Jetzt das Kontaktformular öffnen!

oder Sie erreichen uns unter der Telefonnummer: (040) 88 14 00 36