Hilfe:Verhaltensregeln: Unterschied zwischen den Versionen

Aus Delixs
Zur Navigation springen Zur Suche springen
Zeile 37: Zeile 37:
In den Handbüchern sollte nur das beschrieben werden, was auch auf der CD bereitgestellt wird - eben ein stimmiges System. Alles andere gehört in [[Tools und Anleitungen]] (siehe Link auf der wiki-Hauptseite).
In den Handbüchern sollte nur das beschrieben werden, was auch auf der CD bereitgestellt wird - eben ein stimmiges System. Alles andere gehört in [[Tools und Anleitungen]] (siehe Link auf der wiki-Hauptseite).


Auf '''externe Links''' sollte in den Handbüchern generell verzichtet werden, diese gehören in den '''Angang'''. ''Begründung: Wer einen Server einrichtet oder betreut, muß mittels Handbuch auch dann eine Hilfestellung nachlesen können, wenn das Internet gerade nicht zur Verfügung steht.''
Auf '''externe Links''' sollte in den Handbüchern generell verzichtet werden, diese gehören in den '''Anhang'''. ''Begründung: Wer einen Server einrichtet oder betreut, muß mittels Handbuch auch dann eine Hilfestellung nachlesen können, wenn das Internet gerade nicht zur Verfügung steht.''


== Eingrenzung (Damit die Handbücher keine 1000-Seiten Bücher werden) ==
== Eingrenzung (Damit die Handbücher keine 1000-Seiten Bücher werden) ==

Version vom 15. Juni 2005, 07:26 Uhr


DOKUMENTATIONSVERTRAG (GFDL)

  • Vereinbarung mit der Zeitschrift c't als software Herausgeberin und Unterstützerin des Arktur-Entwicklerteam:

Ich arbeite im Rahmen meiner Interessen und Möglichkeiten mit an der Entwicklung des c't/ODS-Schulserver. Meine freiwillige Beteiligung erfolgt unentgeltlich.

Ich verpflichte mich zur Einhaltung der Bestimmungen aus der beiliegenden GNU Free Documentation License. Alle meine Arbeiten stelle ich unter dieser Lizenz zur Verfügung.

Ich beherzige die beiliegenden Entwicklungsrichtlinien und weitere durch die Entwickler(innen)-Gruppe für Ihre Arbeit zu schaffenden Regeln.

Ich bringe in das Projekt kein Material ein, von dem ich weiss, dass es den geforderten Lizenzbestimmungen oder dem öffentlichem Recht widerspricht, es sei denn, es ist mit fremden Rechte-Inhabern eine explizite Regelung getroffen, die eine legale Verwendung des Materials ermöglicht.

Ich prüfe alle Materialquellen, sofern mir dafür die Urheber- oder Verwertungsrechte nicht bekannt sind und verzichte auf alles Material, für das eine Klärung nicht möglich ist. Ich verzichte auch auf Material, wenn an der Seriösität der Quelle Zweifel bestehen.

Sollten mir nachträglich Verletzungen der beschriebenen Forderungen bekannt werden, so unterstütze ich eine Entfernung des unzulässigen Materials, soweit dies möglich und zumutbar ist.

Verständlichkeit (Nicht nur Profis nutzen Arktur)

Das Installations-, Benutzer- und Administratorhandbuch soll eine übersichtliche, verständliche (Schritt-für-Schritt-)Anleitung sein.

Die Handbücher sollen nachvollziehbar sein, ersetzen aber in der Regel kein Fachbuch. Jeder Artikel sollte deshalb auch für Laien verständlich geschrieben sein.

Das Anliegen eines Handbuches ist nicht, einem wissenschaftlichen Gutachten Genüge zu tun, sondern dem schulischen Nutzer eine übersichtliche und verständliche Anleitung bereitzustellen. Es sollte jeder Beitrag aus dem Blickwinkel der Zielgruppe, des Anwenders betrachtet werden und nicht aus der Sicht des Technikers.

Es wird darauf hingewiesen, das diese Handbücher sich grundsätzlich am Beispiel der Ein-Server-Lösung (also auf Arktur) orientieren. Der Ein-Server- oder Zwei-Server-Lösung wird ein spezielles Kapitel gewidmet, wo die Unterschiede und Besonderheiten angegeben und erklärt sind. In den Titelzeilen der Handbücher sollte aber schon c't/ODS-Schulserver statt Arktur verwendet werden.

In den Handbüchern sollte nur das beschrieben werden, was auch auf der CD bereitgestellt wird - eben ein stimmiges System. Alles andere gehört in Tools und Anleitungen (siehe Link auf der wiki-Hauptseite).

Auf externe Links sollte in den Handbüchern generell verzichtet werden, diese gehören in den Anhang. Begründung: Wer einen Server einrichtet oder betreut, muß mittels Handbuch auch dann eine Hilfestellung nachlesen können, wenn das Internet gerade nicht zur Verfügung steht.

Eingrenzung (Damit die Handbücher keine 1000-Seiten Bücher werden)

Jeder Mitautor akzeptiert, das die verantwortlichen Redakteure nicht versprechen können, das genau sein Artikel auch später ins offizielle Handbuch wandert. Denn: Zu jedem thematischen Punkt im wiki wird nur ein Beispiel ins Handbuch wandern. Beispiel: USV einrichten wird nur konkret an einer APC USV beschrieben. Weitere USV Typen können im Bereich Tools und Anleitungen beschrieben werden, kommen jedoch nicht ins offizielle Handbuch.

Auch die Punkte, die nicht im Handbuch landen, dokumentieren das System "c't/ODS Schulserver", nur eben nicht die Installation oder Nutzung, sondern eben andere Aspekte - gehören also ins wiki. Nur sie kommen nicht als offizielle Dokumentation mit auf die CD des Heise-Verlages c't/ODS Schulserver.