Tutorials

Wer ein Tutorial schreiben möchte, melde sich bitte vorher bei mir, damit niemand Arbeit doppelt macht. Anschließend werde ich denjenigen in die unten stehende Tabelle eintragen und ihn bitten das Tutorial nach den Richlinien anzufertigen.

http://github.com/zeroathome/jabber-tutorials

Die Tutorials werden in einem git-Repository archiviert. Das dient erstens der Versionskontrolle, als auch als Backup. (Außerdem könnte man später die Tutorials direkt aus dem Repo auslesen, anstatt die Dateien zu benutzen)

Das heißt nicht, dass jeder der ein Tutorial schreiben möchte das Repo benutzen muss. Tutorials können auch einfach per Mail (o.ä.) an mich gesendet werden.

Pro OS/Client-Kombination eine JSON-Datei mit dem gleichnamigen Ordner, in dem die Bilder liegen:

tutorial-
        \- [os]-[client]
        |  \-[os]-[client]1.png
        |  |-[os]-[client]2.png 
        |- [os]-[client].json

Beispiel:

tutorial-
        \- winxp-pidgin
        |  \-winxp-pidgin1.png
        |  |-winxp-pidgin2.png 
        |- winxp-pidgin.json

Beispiele einer solchen Ordnerstruktur findet sich hier: http://github.com/zeroathome/jabber-tutorials

Es wird bevorzugt, dass die Tutorials im JSON-Format eingereicht werden. Auch das ist keine Pflicht, Tutorials können auch einfach als Textdatei (plain-text bitte) an mich gesendet werden und ich erledige die Konvertierung.

Für die, die es mit JSON versuchen wollen, sei der JSON-Validator JSONLint empfohlen, um die Datei auf Validität zu prüfen.

Das Format wird in einer kommentierten Beispieldatei erläutert werden. Bis dahin gibt es ein unkommentiertes Beispiel hier.

• Darauf achten, dass das jeweilige Standardtheme des Betriebssystems genutzt wird!
• Falls der Client nicht vorinstalliert ist, bitte die Installation auch beschreiben!

Screenshots sollten

• im PNG-Format sein
• bitte nicht breiter als 600 Pixel sein (zur Not runterskalieren)
• nur das Fenster des jeweiligen Clients enthalten (nicht der komplette Desktop oder Ausschnitte davon) Beispielbilder
• nach dem oben gezeigten Schema benannt sein
• sich in einem Ordner befinden, wie unter Dateistruktur gezeigt

Texte sollten

• in einer JSON, oder einfachen Textdatei geschrieben werden (bitte, bitte kein .doc(x)/.odt oder ähnliches)
• so konzise¹⁾ wie möglich sein, aber trotzdem den Vorgang verständlich erklären
• Anrede ist ausnahmslos “Du”, bitte auch konsequent verwenden

Das Einreichen erfolgt auf zwei Wege:

1. Ihr forkt die Tutorials auf github, fügt euer Tutorial hinzu und sendet einen “pull-request”
2. Falls ihr mit git nichts am Hut habt, packt das Tutorial (egal ob im JSON-Format, oder als plain-text-Datei) zusammen mit den Bildern (die möglichst schon die richtigen Dateinamen haben) in eine .zip-/.tar.gz-/.tar.bz2-Datei und schickt sie per Mail an jabber@zeroathome.de

Falls ihr bei irgendetwas Hilfe braucht, oder nicht weiterkommt, bitte meldet euch einfach unter einer der folgenden Adressen:

• Mail: jabber@zeroathome.de
• Jabber: zeroathome@jabber.ccc.de

dann werde ich versuchen euch so weit ich kann zu helfen. (Ich versuche so bald wie möglich zu antworten, aber nicht wundern wenn das etwas dauern kann.)