| Autor | adhoc |
| Datum | 12.09.2007 09:28 |
| Beiträge: |  stefan schrieb am 12.09.2007 um 07:52:21 Uhr folgendes:
Es sollte drei Arten von Dokumentation geben (oder drei Teile in Einer) 1. ein LEITFADEN (HowTo) der sich vor allem an Beginner (ich möchte nicht von Anfängern sprechen) richtet, worin der "an die Hand genommen wird". Das fängt an bei Entscheidungen, die man vorher treffen muß (welche Datenbank, welches Betriebssystem, ... dazu Entscheidungshilfe: Vorteile/Nachteile ), geht über die Installation, die wichtigsten (häufigsten) Probleme bei der Installation und Einrichtung, über die Grundeinrichtung (was muß ich anpassen, was kann erstmal so bleiben) bis hin zu einer ersten website, die die wichtigsten (häufigsten) Funktionalitäten enthält (Begrüßungs-/Einstiegsseite, Über uns, irgendein Thema, Impressum, Kontakt, Links, sitemap, ...). Wenn man dann als Neuling DORT angekommen ist, hat man die richtige Motivation, um sich "durch den Rest zu qualen". 2. ein LEXIKON, also wo ich, alphabetisch oder thematisch geordnet, was NACHSCHLAGEN kann. Dort würde man z.B. die Beschreibung der einzelnen Module finden. Dies richtet sich an die ANWENDER, die mehr oder weniger täglich damit zu tun haben - und "wie ging das nochmal" oder "wie geht das" brauchen - und keine Grundlegenden Erläuterungen mehr. 3. eine TECHNISCHE Dokumentation, die die System-, Installations-, und sonstige Vorraussetzungen beschreibt, Code-Schnippsel zum "Abkupfern" enthält (man muß nicht jedesmal was neu erfinden), Hinweise zum Geschwindigkeit-Tuning, Datenbank-Geschichten (z.B. technische Unterschiede), webServer(Apache)-Einstellungen, php-Einstellungen, vielleicht Unterschiede der Installation bei verschiedenen Linux-Distributionen (wie heißen die Pakete, die benötigt werden und wo finde ich die). Auch auf die Rechtliche Seite (z.B. Lizenzpflicht für MySQL in gewerblicher Anwendung) sollte aufgeführt sein. Zur Frage "mehr Bilder" kann man nur sagen: Ein Bild sagt mehr wie tausend Worte - muß ja nicht gleich Focus/BildZeitung-Niveau erreichen. Da wo es die Erklärung VEREINFACHT und VERKÜRZT sind Screenshots immer willkommen. Zu Teil 1. würde ich meine Mithilfe anbieten, stecke gerade da drin  ebenso kann ich was zu FireBird /InterBase beitragen.
Christoph |
