Durch die Richtlinien werden zum Teil Vorgaben und zum Teil Empfehlungen dazu geschaffen, wie die Softwareentwicklung in der TRENZ AG stattfindet.
Das betrifft folgende Aspekte:
- Die Struktur: wo finde ich Code?
- Der Stil: wie sieht der Code aus?
- Die Qualität: was muss der Code beinhalten?
- Die Dokumentation: warum wurde der Code so geschrieben?
Warum?
Der Code wird "besser" und richtiger".
Hauptsächlich aber geht es um Einheitlichkeit!
Wenn ihr in ein Projekt eines anderen Entwicklers einsteigt, könnt ihr so schneller folgende Fragen beantworten:
- wo finde ich den Code?
- wie sieht dieser aus?
- und: warum wurde er so geschrieben?
Verbindlichkeit
Diese Richtlinien haben keinen Anspruch, perfekt zu sein, sondern werden laufend verbessert. Sie sollen aber — auch jetzt schon — eure Arbeit untereinander erleichtern.
Manche Aspekte sind so subjektiv, dass in den Richtlinien das Verb "soll" verwendet wird. Das bedeutet dann, dass ihr es anders machen dürft: es ist nur eine Empfehlung.
Vieles hingegen ist festgelegt. Taucht das Verb "muss" in den Richtlinien auf, so ist eine Richtlinie als Vorgabe zu verstehen, und einzuhalten.