Pflichtenheft von byteme - PI - Praktische Informatik

64 KAPITEL 7. QUALITÄTSSICHERUNG
• Hinreichende Kommunikation intern und extern zur Bildung einer gemeinsamen
Basis und zur Vermeidung von Missverständnissen.
In den folgenden Unterkapiteln werden diese Verfahren detailliert erläutert.
7.3.2 Richtlinien
Ziel von einheitlichen Konventionen bei der Durchführung wichtiger Prozesse im Projekt
ist die Gewährleistung von Transparenz und Wartbarkeit des Produktes. Dadurch
wird sowohl die Zusammenarbeit in der Gruppe unterstützt, als auch die spätere Weiterentwicklung
durch den Auftraggeber und ggf. die Open-Source-Gemeinde erleichtert.
7.3.3 Dokumentation von Änderungen
Jede Modifikation eines Dokumentes wird dokumentiert. Dies betrifft vor allem den
Quelltext, aber auch alle schriftlichen Dokumente wie z.B. das Benutzer- und Entwicklerhandbuch.
Dies wird aus technischer Sicht für den Quellcode und die Testdefinitionen
durch den Einsatz des Programmpakets CVS (Concurrent Version System) gewährleistet.
Durch den Einsatz von Eclipse, in dem eine umfassende CVS-Unterstützung
integriert ist, wird die Nutzung dieses Systems durch alle Gruppenmitglieder sichergestellt.
Hierbei wird bei jedem „Commit“-Vorgang, d.h. bei jedem Hinzufügen von
neuem oder Ändern von bestehendem Code, ein begleitender Kommentar abgefragt.
Wir haben daher die Regel aufgestellt, commits stets mit sinnvollen Kommentaren
durchzuführen. Dadurch können Änderungen einheitlich protokolliert werden und die
Versionskontrolle ist gewährleistet.
Bei anderen Dokumenten, wie z.B. diesem Pflichtenheft, werden grundsätzlich alle
alten Versionen archiviert und sind stets über den Dateibereich auf unserer Homepage
verfügbar.
7.3.4 Layout und Stil
Dokumentation:
Für alle schriftlichen Dokumente werden einheitliche Formatvorlagen verwendet. Diese
wurden vom Zuständigen für die Qualitätssicherung erzeugt. Er überprüft auch die
Einhaltung und Benutzung der Vorlagen. Die Einhaltung von Layoutkonventionen ist
sehr wichtig, da Dokumente in der Regel auch lange nach ihren Erstellungsdatum noch
oft gelesen werden, und ein einheitlicher Stil das Zurechtfinden erheblich verbessert.
Programmierstil:
Auch die Formatierung der Quelltexte und das Klassendesign sind einheitlich festgelegt.
Dies erleichtert vor allem die Lesbarkeit von Komponenten, die von anderen
Gruppenmitgliedern erstellt wurden. Zu einem guten Programmierstil gehört auch die
Dokumentation im Quelltext und die Einhaltung von bestimmten Richtlinien bei der
Benennung von Variablen, Methoden und Klassen. Im wesentlich orientieren wir uns
hierbei am Java Style Guide der Firma Sun. Einige Punkte werden nachfolgend kurz
erläutert.