PHP 4.3

14.7.2 Dokumentation

Wie bereits erwähnt, sollten alle wichtigen Entscheidungen aufgeschrieben werden. Das hilft nicht nur während der eigentlichen Programmierung am Projekt im Team, sondern ermöglicht es auch, später Fehler zu finden oder Änderungen und Erweiterungen am bestehenden Code vorzunehmen. Insbesondere sollten folgende Dinge dokumentiert und die Dokumentation mit den Programmdateien abgespeichert werden:

  • die Seitenstruktur
  • die Aufgaben der einzelnen Seiten und die Funktion der enthaltenen Skripte
  • die gespeicherten Daten (Sessions, Cookies, Datenbanken, Dateien) mit Namen und Aufbau
  • die übergebenen URL-Parameter bzw. Formulardaten
  • die Funktionen mit Namen, Parametern, Rückgabewerten und Aufgaben
  • die ausgelagerten HTML-Teile und PHP-Skripte

Versuchen Sie diese Angaben in einer möglichst übersichtlichen Form darzustellen, bei der die wichtigen Informationen so hervorgehoben sind, dass man sie schnell findet. Dabei müssen Sie bedenken, dass ein Sinn und Zweck dieser Dokumentation ist, dass sich später ein anderer Programmierer in Ihr Projekt einarbeiten kann, um Erweiterungen vorzunehmen. Sie schreiben also nicht (nur) für Ihr eigenes Team, das sich bereits mit dem Stoff beschäftigt hat, sondern auch für jemanden, dem Ihr Projekt neu ist.

Zu einer vollständigen Dokumentation gehören natürlich noch weitere Teile:

  • eine vollständige Anforderungsbeschreibung
  • Gründe, warum bestimmte Entscheidungen gefallen sind, warum Alternativen ausgeschlossen wurden
  • Protokolle der durchgeführten Tests

Wichtiger Bestandteil der Dokumentation ist auch der HTML- und PHP-Code, denn diesen sieht ein Programmierer, der später Fehler beheben oder Erweiterungen vornehmen soll, in jedem Fall. Das bedeutet nicht, dass Sie den Code ausdrucken müssen, sondern dass Sie auch diesen übersichtlich gestalten sollten. Um dies zu gewährleisten wurden Programmierkonventionen entwickelt, deren Einhaltung es ermöglicht, sich auch in fremdem Code zurechtzufinden. Sie werden Ihnen im Anschluss vorgestellt.

Tests

Zum erfolgreichen Abschluss eines Projektes gehört das Bestehen eines vollständigen Tests. Sicherlich testen Sie beim Programmieren Ihre Seite(n) immer wieder selbst. Wichtig aber ist, dass am Ende auch das gesamte Projekt, also alle Seiten gemeinsam, funktionieren. Deshalb sollte am Ende eine Simulation eines wirklichen Besuchs auf Ihren Seiten stehen. Lassen Sie Kollegen die Seiten durchwandern und alle Funktionen ausprobieren. Treten dabei Fehler auf, müssen Sie wieder zurück zur Programmierung und die Fehler beheben. Wichtig ist, dass Sie solch einen Abschlusstest nicht selbst vornehmen, sondern von Personen durchführen lassen, die sich nicht mit Ihrem Projekt beschäftigt haben. Nur so können Sie feststellen, ob Ihre Seiten wirklich übersichtlich sind und die Erwartungen von Websurfern erfüllen. Sinnvollerweise planen Sie solche Testdurchläufe auch schon während des Projektes ein, um Fehler möglichst früh zu entdecken.

Normalerweise sind auch Tests von Programmen gut geplant, und es gibt viele Theorien darüber, wie man Testeingabedaten findet. Diese wollen wir hier nicht alle behandeln, aber Sie sollten sich folgende Grundregeln merken:

  • Probieren Sie alle Funktionalitäten eines Skripts mindestens einmal aus.
  • Folgen Sie einmal allen Links.
  • Testen Sie die Funktion jedes Buttons.
  • Probieren Sie bei jedem Formular mehrere sinnvolle, aber auch einige unsinnige (z.B. Buchstabe statt Zahlen) Eingaben aus.
  • Erzeugen Sie auch Fehler außerhalb des Skriptes (z.B. Abschalten des Datenbankservers, Verschieben einer benötigten Datei) und prüfen Sie, ob Ihr Skript angemessen reagiert.
  • Testen Sie Ihre Webseiten mit unterschiedlichen Browsern.
  • Führen Sie auch Tests mit im Browser deaktivierter Cookie-Funktion durch.

Erst wenn alle Tests zu Ihrer Zufriedenheit bestanden sind, können Sie Ihre Seiten frei verfügbar ins Internet stellen. Zwar kann es auch dann noch zu Fehlern kommen, die vorher nicht aufgefallen sind und nun im Nachhinein behoben werden müssen, aber Sie haben alles getan, damit dies möglichst wenig geschieht.

Kommentare (0)

Ihr Kommentar

Name