Dokumentation für Redaxo 5

Zeitgleich mit der ersten Beta-Veröffentlichung von Redaxo 5 haben wir mit der Arbeit an der Dokumentation begonnen. Initiiert durch Sascha Weidner haben wir uns für folgenden Workflow entschieden:

Wir arbeiten gemeinsam und versioniert an der Dokumentation in diesem Github-Repo:
https://github.com/redaxo/dokumentation

Bei Änderungen und Ergänzungen wird dann jeweils aktuell die eigentliche Dokumentation generiert, die in Form von \“Gitbooks\” auf der Redaxo-Website zu finden ist:
http://book.redaxo.org/

Wir planen, das Handbuch zu unterteilen in “REDAXO für Anwender” (einfache Admin-Tätigkeiten wie Installation und erste Schritte) sowie “REDAXO für Entwickler” (die Arbeit mit Templates und Modulen, die Entwicklung von AddOns sowie komplexere Erweiterungen).

Bisher findet sich schon einiges an Inhalt in dieser neuen Doku, aber es gibt natürlich noch große Lücken, und wir müssen noch viel an der Vervollständigung arbeiten.
Dazu brauchen wir auch Eure Hilfe:

  • Wir sind offen für Vorschläge, was alles in der Dokumentation enthalten sein soll.
  • Betrachtet die Struktur als erste Basis. Wir sind gern bereit, die Struktur durch Eure Anregungen zu überarbeiten und erweitern.
  • Über Korrekturen, Ergänzungen und eigene Textbeiträge freuen wir uns. Willst Du ein bestimmtes Segment dokumentieren? Je mehr Eurer Ideen einfließen, umso vollständiger und besser wird die Dokumentation werden.

Wie könnt Ihr helfen?

Direkt über Beteiligung per Github

Pull requests
Ihr könnt gerne jederzeit Texte als Pull request senden. Dazu benötigt ihr einen Github-Account. Wenn ihr eine Datei ändern wollt, klickt diese an und editiert sie, nach dem Speichern könnt ihr uns die Änderungen als PullRequest zukommen lassen.

Issues
Gerne könnt ihr uns auch kleinere Änderungen per Issues zukommen lassen. Schreibt dazu unbedingt, um welches Handbuch es sich handelt: [5.0 – Advanced] oder [5.0 Manual].

E-Mail

In Kürze werden wir auch eine Support-Mail einrichten. Schickt uns die Inhalte dort als Zip-Datei zu und wir überprüfen die Datein bzw. stellen sie ggf. online.

Bitte seid nicht böse, falls Eure Ideen nicht komplett oder nicht unbearbeitet übernommen werden. Das Doku-Team wird aber dennoch jede Anregung prüfen und versuchen, diese so gut wie möglich und passend zum Gesamtkonzept der Dokumentation einzuarbeiten.

Im Forum kann das weitere Vorgehen bei der Doku-Erstellung derzeit in folgendem Thread diskutiert werden:

http://www.redaxo.org/de/forum/post116477.html

Wir freuen uns auf Eure Kommentare!

Hinweis: Inzwischen wurde der Workflow geändert. Stand Januar 2017.