2.3 Konventionen

Konvention Erläuterungen, Hintergrund
Architekturdokumentation
Gliederung nach dem deutschen arc42-Template in der Version 6.0
Kodierrichtlinien für Java Java Coding Conventions von Sun/Oracle, geprüft mit Hilfe von CheckStyle
Sprache (Deutsch vs. Englisch) Benennung von Dingen (Komponenten, Schnittstellen) in Diagrammen und Texten innerhalb dieser (deutschen) arc42-Architekturdokumentation in Deutsch.

Verwendung deutscher Bezeichner für Klassen, Methoden etc. im Java-Quelltext (es sei denn, die Java-Kodierrichtlinien stehen dem im Wege).

Hintergrund: Die Zielgruppe sind keine Schach-Experten, es soll keine zusätzliche Barriere durch englische (Schach-)begriffe erzeugt werden.
Schach-spezifische Datenformate Verwendung etablierter Standards für Schach-spezifische Notationen und Austauschformate innerhalb der Lösung.

Themen: Züge, Stellungen, Partien, Eröffnungen, ...
Keinesfalls sind eigene Formate zu entwickeln.

Prinzip: Offene Standards sind proprietären Formaten (wie sie ggf. kommerzielle Programme verwenden) vorzuziehen.