Anleitung

Die Programmierrichtlinien sind in Kapitel gegliedert, jedes Kapitel kann beliebig viele Regeln enthalten. Das sieht dann zum Beispiel so aus:

SAS-Programmierrichtlinien
   Anleitung
   Codelayout
      Regel 1 zum Codelayout: z.B. Einrückungen
      Regel 2 zum Codelayout: z.B. Eine Anweisung pro Zeile
      ...
   Modularisierung
      Regel 1 zur Modularisierung
      ...
   Kommentare
      ...
   Namenskonventionen
   Kontrollfluss
   Fehlervermeidung
   sonstiges
   Metaregeln 
   Links

Diese Kapitel wurden bereits von mir angelegt.

Jedes Redscope-Mitglied kann nun:

  • im Projekt navigieren: siehe Handbuch.
  • neue Regeln anlegen: eine untergeordnete Seite zu einem Kapitel erstellen (Link "untergeordnete Seite erstellen" am unteren Rand anklicken). Neue Seiten werden von den Betreibern innerhalb kurzer Zeit freigeschaltet und können dann vom "Besitzer" beliebig oft verändert werden, siehe auch die Anleitung im Handbuch.
  • neue Kapitel vorschlagen: eine untergeordnete Seite zum Haupteintrag "SAS-Programmierrichtlinien" erstellen. Zum Erstellen neuer Seiten siehe voriger Punkt.
  • Kommentare zu Kapiteln oder zu Regeln schreiben (Link "Kommentieren" am unteren Rand klicken) und sich so an der Diskussion beteiligen.
  • Kapitel oder Regeln abonnieren, um informiert zu werden, wenn jemand einen Kommentar schreibt oder den Text verändert.
  • die Druckversion ansehen (Link "Druckversion" am unteren Rand anklicken).

Es ist sicher sinnvoll, wenn jede Regel knapp und präzise formuliert wird. Eine Begründung und eines oder mehrere Beispiele ergänzen die Regel. Manchmal ist es auch sinnvoll, ein Beispiel dafür zu geben, wie man es nicht machen sollte.

Die Überschrift einer Regel sollte treffend und maximal wenige Worte lang sein, weil dies die Navigation vereinfacht.