Fertig
Am Handbuch arbeiten
Voraussetzung
Voraussetzung für das Arbeiten der Autoren am Handbuch ist der Zugang zu git.buchner.de und ein Windows-Computer oder Mac. Zu Git gibt es in diesem Handbuch einige Hinweise.
Vor der Arbeit ist ein wenig Installationsaufwand nötig, der hier beschrieben ist.
Als nächstes ist ein Editor notwendig, um Änderungen an Dateien des Repositorys vorzunehmen. Der kostenlose Editor Atom ist hervorragend geeignet.
Das ganze Handbuch ist in der Programmiersprache Markdown, sodass sich Grundkenntnisse dieser einfachen Sprache lohnen.
Für das Erstellen von Screenshots gibt es verschiedene Möglichkeiten. Es gibt allerdings nur die Konvention, dass die Bilder einen blauen Rahmen (Farbe #306CAE) haben. Das kann auch mit Grafikprogrammen erreicht werden.
Die Support-Mitarbeiter brauchen einen Internetbrowser und eine Ahnung von Marker.io
Ziele
Ziel ist es, dass
-
auf jede Anleitung, die in den develop-Branch gemerged wird, zwei Augenpaare geschaut haben
-
die Anleitungen nach der Fertigstellung so zügig, wie möglich veröffentlicht werden
-
alle Beteiligten so wenig administrativen Aufwand, wie möglich haben
Arbeitsablauf
-
Ein Issue wird erstellt. Entweder direkt in git oder über Marker.io
-
Ein Autor erstellt einen Branch mit Hilfe eines Merge requests (MR) und weist sich diesen zu (oben rechts Assignee)
-
Der Autor lädt sich den Branch auf seinen Rechner und bearbeitet ihn dort
-
Nach Fertigstellung bekommt der MR das Label Code review und in einem Kommentar wird ein zweiter Autor fürs Korrekturlesen erwähnt
-
Der zweite Autor weist sich auch diesen MR zu
-
Verbesserungen werden direkt geändert und anschließend wird der MR gemerged
-
Sollte sich der Bedarf ergeben, kann der MR an den ersten Autor zum erneuten Korrekturlesen zurück gegeben werden. Dafür muss der erste Autor in einem Kommentar erwähnt werden und ist dann für das Mergen verantwortlich