Dokumentationsleitfaden

Ablage der Doku

Die Dokumentation liegt auf The Drupal Documentation Project (http://www.tddp.de).

Dokugrundlagen/-prinzipien

Die Dokumentation nutzt verschiedene Perspektiven, um die Dokumentation zugänglich zu machen. Die Dokumentation kann nach diesen Daten durchsucht bzw. daraufhin gefiltert werden.

Inhaltstypen

Book page: Standard: beinhaltet Beschreibungen, Tutorial, Referenzen

Project: Sonderfall: beinhaltet eine Art erweiterten Taxonomyeintrag für Projects (im Drupal-Sinn), d.h. Module, Themes usw.

Buchstruktur

Die Buchstruktur ist hierarchisch gegliedert und dient als Handbuch, um sich in Drupal einzuarbeiten.

Struktur der Themengebiete

Themengebiete

Themengebiete sind die offiziell festgelegten Themengebiete der Dokumentation. Neue Themengebiete werden unter Umständen vom Administrator angelegt, wenn sich genug freie Tags (s. Tagging) zu einem Thema angelegt werden.

Dokumente können gleichzeitig zu mehreren Themengebieten gehören.

Tagging

Tags können frei von jedem Nutzer definiert werden, um Inhalte zu kennzeichnen.

Neue Tags werden dem Administrator gemeldet, der diese bei ausreichender Häufigkeit offiziell als Thema anlegt.

Dokumente können gleichzeitig mehrere Tags haben.

Dokumententypen

Die deutsche Dokumentation beschränkt sich auf drei Dokumententypen mit unterschiedlicher Zielsetzung. In jedem Dokumententyp können Texte, Bilder und Videos verwendet werden.

Jedes Dokument kann nur zu einem Dokumententyp gehören.

Zusammenfassung/Übersicht

Einleitender Text zu einem Modul, um Sinn und Zweck des Moduls zu erklären.

Referenz/API

Funktionale Beschreibung von Schnittstellen, Funktionen, Benutzeroberflächen, etc.

Lernanleitung/Tutorial

Eine Lernanleitung / ein Tutorial beschreibt wie Aufgaben ausgeführt werden, auch über mehrere Module / Themengebiete hinweg.

Nutzergruppen

Die verschiedenen Nutzergruppen repräsentieren die typischen Personenkreise, die Drupal in verschiedenen Funktionen nutzen.

Eine Person kann gleichzeitig zu mehreren Nutzergruppen gehören.

Ein Dokument kann gleichzeitig für mehrere Nutzergruppen relevant sein.

Anwender

Anwender haben mit der Entwicklungsseite von Drupal nichts zu tun, sondern nutzen bestehende Module bzw. Installationen.

Admin: Typische Aufgaben: Installation, Verwaltung von Rechten und Rollen. Evtl. Seitenstruktur anlegen und ändern.

Nutzer: Typische Aufgaben: Inhalte anlegen, ändern und löschen. Evtl. Seitenstruktur anlegen und ändern.

Business/Marketing: Typische Aufgaben: Beratung von Kunden bei der Auswahl eines CMS; Informieren über Vor- und Nachteile von Drupal.

Entwickler: Typische Aufgaben: Entwickeln von neuen Modulen, Anpassen von bestehenden Modulen.

Themer: Typische Aufgaben: Entwickeln neuer Themen, Anpassen von bestehenden Themen.

Konzeption/Projektleitung

Typische Aufgaben: Zusammenstellen der für die Erfüllung von Kundenanforderungen notwendigen Module, Identifizieren von notwendigen Anpassungen bzw. Neuerstellungen von Modulen und Themen.

Schwierigkeitsgrad

Der Schwierigkeitsgrad ist ein Indikator für die notwendige Erfahrung, um das Dokument zu verstehen.

Die Schwierigkeitsgrade sind:

Einsteiger: Arbeitet hauptsächlich nach „Rezept“.

Fortgeschritten: Leistet Transferleistungen, z.B. von einer Problemlösung in einem Modul auf Programmieraufgabe in einem anderen Modul.

Experte: Erstellt eigenständige/neue Konzepte, Codes, Themen.

Drupal-Version

Gibt an, für welche Drupal-Version dieses Dokument gültig ist.

Modul-Version

Gibt an, für welche Modul-Version dieses Dokument gültig ist.

Stil

Als Anrede ist "Sie" zu verwenden.

 

Link zum englischsprachigen Drupal-Styleguide

Themengebiet:

Dokumententyp: