Battleship 5
Definition der Dokumenation
Zur korrketen und vollständigen Dokumentation des Projekts werden folgende Dokumente erstellt:
README.md
- Foramt: Markdown
- Zielgruppe: Software-Entwickler
- Ort: Git Repository, Root Verzeichnis
- Sprache: Englisch
Soll Software-Entwicklern einen schnellen überblick über das Programm geben und zum einfachen aufsetzen des Projekts helfen
Schnitstellendkumentetion
- Format: JSDoc (TernJS)
- Zielgruppe: Software-Entwickler
- Ort: im Quellcode des Produkts, als Website
- Sprache: Englisch
Dokumentation die die einzelnen funktionen, module, etc. des Programms beschreibt.
Labordokumentation
- Format: Markdown
- Zielgruppe: Betreunder Lehrer, Interessierte
- Ort: E-Mail, nvs.schreib.at
- Sprache: Deutsch, Englisch
Fortlaufende Dokumentation welche über den Fortschritt des Projekts informiert
Benutzerdokumentation
- Format: Markdown
- Zielgruppe: Endnutzer
- Ort: Auf der Website des Projekts (Support)
- Sprache: Englisch
Dokumentiert die Nutzung der einzelnen Funktionen die auf der Webseite bereitgestellt werden.