Website - Dokumente

Website - Dokumente

Download: Website-Dokumentation (PDF-Datei: 1 MB)

Website-Dokumentation Version 0.3 Stand 21.02.2013

Es gibt keine allgemein gültige Lösung wie man eine Dokumentation schreibt. Hier ist ein möglicher Ansatz, der sicherlich noch ausbaufähig ist.

Deckblatt

Mit Titel, Personalien, Kontaktdaten und Kurzbeschreibung.

Verzeichnisse

Dazu gehören sicher ein Inhaltsverzeichnis, Tabellenverzeichnis und Abbildungsverzeichnis.

Planungsphase

Ein kurzes Management Summary über die groben Ziele und Inhalte der Website aus dem Grob- und Fein-Konzept.

Realisierungsphase

Wie wurde das Konzept umgesetzt mit: Benutzte Hard- und Software, Bearbeitung der Bilder und Texte, speziell verwendete Scripts, Abänderungen des Fein- und Design-Konzepts.

Ordner-Struktur

Was befindet sich wo und weshalb: Beschreibung, Pfadangaben und Screenshots lokal und auf dem Server.

Style-Guide

Wie sind die einzelnen Bereiche der Website programmiert und formatiert worden: DIV-Identifikation, Style-Sheets, spezielle HTML-Tags, Bildformatierungen, Header, Body, Navigation, Footer etc...

Farb-Tabellen

Für die Bereiche der Website werden ausführliche Farbtabellen erstellt für: Homepage, Inhaltsseiten, Header, Body, Navigation, Footer etc...

Launch

Die Rahmenbedingungen, unter denen die Website aufgeschaltet wurde: Meta-Angaben, Provider-Angaben, Suchmaschinen-Anmeldungen, Wartungsleitfaden.

Definition: Dokumentation

Unter Dokumentation versteht man die Nutzbarmachung von Informationen zur weiteren Verwendung.

Link zu Wikipedia

Im Informatik-Bereich

Dokumentation bedeutet in den Bereichen Projekt-Management und Software-Entwicklung, sämtliche Schritte und Maßnahmen zu dokumentieren. Ziele: Nachvollziehbarkeit und Lerneffekte.

Ziele

Ziel der Dokumentation ist es, schriftlich oder auf andere Weise dauerhaft niedergelegte Informationen (Dokumente) gezielt auffindbar zu machen.

Dokumente in diesem Sinne können Fachbücher, Zeitschriftenartikel oder sonstige Druckschriften sein, aber auch Bilder, Filme, Tonaufzeichnungen und ähnliches.

Auch wissenschaftlich erhobene Daten können im Sinne einer Dokumentation behandelt werden.

(Quelle: Wikipedia)