Sprachkonventionen

Hier sollen eine Reihe von Sprachkonventionen gesammelt werden. Sie dienen nicht dem Zweck, die Sprache zu standardisieren, sondern stellen lediglich einige Richtlinien zum Schreiben und Korrigieren von Texten dar. Sie sollen nicht als strikte Regeln gesehen werden, sondern mehr als Empfehlungen, die die Korrektur der Texte erleichtern sollen. Die Handhabung der Punkte, deren Formulierungen mit können gebildet werden, obliegt dem jeweiligen Autor bzw. Korrekturleser.

Abkürzungen werden, sofern es keine feststehenden Namen sind (z.B. 'MySQL'), groß geschrieben

• Doppelte Anführungszeichen werden für Zitate und Umschreibungen (die generell jedoch vermieden werden sollten) benutzt
• Einfache Anfühungszeichen können verwendet werden, um einzelne Wörter oder Buchstabenkombinationen hervorzuheben, die keine Zitate sind (Variablen/Funktionen aus Codebeispielen etc.)

Nach Abschluss eines Textes kann der Autor seine Texte automatisch korrigieren lassen (z.B. mit Aspell (Win32)), um dem Korrekturleser diese Arbeit abzunehmen

Fachausdrücke und Namen von Software o.ä. werden so geschrieben, wie sie üblicherweise geschrieben werden bzw. wie es vom Autor vorgesehen ist (z.B. 'MySQL' und nicht 'MYSQL' oder 'mysql')

• Kombinationen aus deutschen Wörtern werden nur dann auseinander geschrieben, wenn das Zusammenschreiben die Lesbarkeit erschwert
• Kombinationen aus deutschen und englischen Wörtern werden mit Bindestrich getrennt (es ist darauf zu achten, dass einige eingedeutschte Wörter nicht als englische Wörter gesehen werden und somit nicht durch Bindestrich getrennt werden sollte (z.B. 'Codebeispiel' statt 'Code-Beispiel').
• Kombinationen aus englischen Wörtern werden üblicherweise mit Leerzeichen getrennt (z.B. 'Coding Rules'; unbekanntere Ausdrücke können durch einfache Anführungszeichen hervorbehoben werden)

Umlaute können auch durch 'ae', 'oe', 'ue' umschrieben werden, sollten dann jedoch durch den Autor/Korrekturleser durch korrekte Umlaute ersetzt werden (Suchen & Ersetzen; es ist darauf zu achten, dass dies nicht automatisiert wird, da sonst auch Worte wie 'neue' ('neü'), 'aktuell' ('aktül') u.a. betroffen sind).

Es wird auf deutsch dokumentiert und geschrieben, daher sollte darauf geachtet werden, auf englische Begriffe möglichst zu verzichten und eine passende deutsche Übersetzung zu suchen, eingedeutschte Begriffe und Fachausdrücke sind davon natürlich ausgenommen. Die genaue Handhabung obliegt auch hier dem jeweiligen Autor bzw. Korrekturleser

Einstellige Zahlen können ausgeschrieben, alle anderen Zahlen einfach als Zahl geschrieben werden (Zahlen aus Codebeispielen u.ä. sind davon ausgenommen)