Hilfe:Verhaltensregeln: Unterschied zwischen den Versionen
(17 dazwischenliegende Versionen von 3 Benutzern werden nicht angezeigt) | |||
Zeile 2: | Zeile 2: | ||
== DOKUMENTATIONSVERTRAG (GFDL) == | == DOKUMENTATIONSVERTRAG (GFDL) == | ||
Ich arbeite im Rahmen meiner Interessen und Möglichkeiten mit an der Entwicklung des | Ich arbeite im Rahmen meiner Interessen und Möglichkeiten mit an der Entwicklung des | ||
delixs-Schulserver. Meine freiwillige Beteiligung erfolgt unentgeltlich. | |||
Ich verpflichte mich zur Einhaltung der Bestimmungen aus der beiliegenden [ | Ich verpflichte mich zur Einhaltung der Bestimmungen aus der beiliegenden [http://www.gnu.org/copyleft/fdl.html GNU Free Documentation License]. Alle meine Arbeiten stelle ich unter dieser Lizenz zur Verfügung. | ||
Ich beherzige die beiliegenden Entwicklungsrichtlinien und weitere durch die | Ich beherzige die beiliegenden Entwicklungsrichtlinien und weitere durch die | ||
Entwickler(innen)-Gruppe für Ihre Arbeit zu schaffenden Regeln. | Entwickler(innen)-Gruppe für Ihre Arbeit zu schaffenden Regeln. | ||
Ich bringe in das Projekt kein Material ein, von dem ich | Ich bringe in das Projekt kein Material ein, von dem ich weiß, dass es den geforderten | ||
Lizenzbestimmungen oder dem öffentlichem Recht widerspricht, es sei denn, es ist mit fremden | 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 | Rechte-Inhabern eine explizite Regelung getroffen, die eine legale Verwendung des Materials | ||
Zeile 19: | Zeile 17: | ||
Ich prüfe alle Materialquellen, sofern mir dafür die Urheber- oder Verwertungsrechte nicht bekannt | 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 | sind und verzichte auf alles Material, für das eine Klärung nicht möglich ist. Ich verzichte auch auf Material, wenn an der Seriosität der Quelle Zweifel bestehen. | ||
Sollten mir nachträglich Verletzungen der beschriebenen Forderungen bekannt werden, so | 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. | unterstütze ich eine Entfernung des unzulässigen Materials, soweit dies möglich und zumutbar ist. | ||
==Verständlichkeit== | == Verständlichkeit (Nicht nur Profis nutzen delixs) == | ||
Das Installations-, Benutzer- und Administratorhandbuch soll eine | Das Installations-, Benutzer- und Administratorhandbuch soll eine | ||
übersichtliche, verständliche (Schritt-für-Schritt-)Anleitung sein. | ü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 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 Nutzer der Zielgruppe eine übersichtliche und verständliche Anleitung bereitzustellen. Es sollte jeder Beitrag aus dem Blickwinkel dieser Zielgruppe, also 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 delixs) orientieren. Der [[Installationshandbuch:Zwei-Server|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 <b>delixs-Schulserver</b> statt <b>delixs</b> 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 <b>Tools und Anleitungen</b> beschrieben werden, kommen jedoch nicht ins offizielle Handbuch.'' | |||
Auch die Punkte, die nicht im Handbuch landen, dokumentieren das System "delixs-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 '''delixs-Schulserver'''. | |||
---- | |||
<div align="right">[[Delixs:Hilfe|zurück]] | [[Hauptseite]]</div> | |||
[[Kategorie:Hilfe]] | |||
Aktuelle Version vom 27. März 2011, 16:21 Uhr
DOKUMENTATIONSVERTRAG (GFDL)
Ich arbeite im Rahmen meiner Interessen und Möglichkeiten mit an der Entwicklung des delixs-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 weiß, 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 Seriositä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 delixs)
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 Nutzer der Zielgruppe eine übersichtliche und verständliche Anleitung bereitzustellen. Es sollte jeder Beitrag aus dem Blickwinkel dieser Zielgruppe, also 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 delixs) 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 delixs-Schulserver statt delixs 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 "delixs-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 delixs-Schulserver.