Technisches Handbuch
| Projekt: |
Name des Projektes |
| Autor: |
Mitarbeiter, welche(r) verantwortlich für die Erstellung dieses Dokumentes ist |
| Version: |
Eindeutige Nummer, die die Version dieses Dokumentes identifiziert |
| Letzte Änderung: |
Datum, an dem dieses Dokument zuletzt geändert wurde |
| Dateiablage: |
Ort an dem die Datei, in der das Dokument gespeichert ist, abgelegt ist (Rechner, Pfad, Dateiname) |
Installation und Konfiguration
Beschreibung wie das System zu installieren ist (Installationsroutine, Verzeichnisstruktur, benötigte Dateien, Aufsetzen der Datenbank) ?
Beschreibung wie das System zu konfigurieren ist (benötigter Speicher/Plattenplatz, Datenbankgröße, ...) ?
Systembetreuung
Zyklische Arbeiten
Welche täglichen Arbeiten sind zu erledigen (Datensicherung, Überwachung wichtiger Log-Dateien, ...) ?
Welche anderen zyklischen Arbeiten sind zu erledigen (Datenbank-Reorganisation starten, Jahresabschluss, ...) ?
Arbeiten zu bestimmten Ereignissen
Falls bei bestimmten Gelegenheiten außergewöhnliche Maßnahmen zu treffen sind, dann ist dies unter dieser Überschrift zu beschreiben. Dies kann zum Beispiel das Auslagern von Daten betreffen, wenn die Datenbank zu groß wird.
Fehlerbeseitigung
Wie ist auf das Auftreten der verschiedenen Fehler zu reagieren ?
| Symptome | Ursache | Gegenmaßnahmen |
|---|---|---|
|
Beschreibung der Symptome, die auf einen bestimmten Fehler hinweisen (z.B. die Meldung "Error: Impossible to create new user") |
Ursache, die dem Fehler zugrunde liegt (z.B. der Plattenplatz zum Anlegen einer Benutzerdatei reicht nicht aus) |
Maßnahmen die getroffen werden müssen, um den Fehler zu beheben und die dazu führen, dass der Fehler nicht wieder auftritt (z.B. Dateien auf Band auslagern, ...) |
| ... | ... | ... |
Änderungsübersicht
| Version | Datum | Bearbeiter | Beschreibung |
|---|---|---|---|
|
Eindeutige Versionsnummer |
Datum, an dem die Änderung abgeschlossen wurde |
Mitarbeiter, welche(r) die Änderung durchgeführt hat |
Allgemeine Beschreibung was geändert wurde |
|
... |
... |
... |
... |