Guten Abend,

ich habe den Auftrag erhalten eine Website zu erstellen und alles wichtige zu Dokumentieren. Ich bin kein Webdesigner oder Programmierer, habe aber Privat vor einigen Jahren erste Erfahrungen mit Wordpress gesammelt und bastle daher etwas zusammen. Daran soll es nicht scheitern, allerdings weiß ich nicht wie solch eine Dokumentation aussieht und ich finde auch nichts dazu. Vielleicht bin ich auch nur zu blöd zum googlen. :upps

Meine Abschlussarbeit (Ausbildung) war auch eine Dokumentation allerdings handelte es sich um die Planung, Durchführung,... eines Netzwerkes. Daraus kann ich leider nur wenig anfangen. Die Planung fällt im aktuellen Fall schon mal raus, es geht denke ich mal eher um Umsetzung, welche Einstellungen vorgenommen wurden für Plugins, welche Tests durchgeführt wurden und wie sich spezielle Module bedienen lassen.

Momentan bin ich mitten in der Arbeitsphase und zerbreche mir nebenbei seit Tagen den Kopf wie diese Doku aufgebaut sein soll und was ich reinschreiben kann. Mir gefällt diese Unterteilung am besten:

1. Einleitung = Worum geht es, welche Aufgaben sollen erfüllt werden

2. Welche Plugins und welche Templates kommen zum Einsatz

3. Getroffene Einstellungen der Software und der einzelnen Plugins

4. Anleitungen zur Bedienung der speziellen Module

5. Durchgeführte Tests

6. Arbeitsaufwand

Gibt es zu diesem Thema einen speziellen Begriff oder warum finde ich nichts im Netz?

Vorweg:

Ich bin im ersten LJ zum FIAE und stecke noch nicht sooo tief drin.

Bei uns bedeutet Dokumentation, dass alle Klasse, Methoden, öffentliche Variablen etc. kommentiert werden: Was macht die Funktion, was haben die Parameter zu bedeuten, was wird zurückgegeben, welche Besonderheiten gibt es.

Bei Stylesheets, die ja oft viel "Kleinkram" enthalten wiederum werden durch Kommentare Blöcke definiert, um später einen besseren Überblick zu haben.

Grob gesagt ist Sinn der Doku, dass sich Dritte schnell und einfach in den Code einarbeiten können.

Was du aufzählst, klingt für mich eher nach Pflichtenheft.

Aber wie gesagt - 1. LJ...