Fertig
Marker.io
- Workflow
- Handbücher bei buchner
- Voraussetzungen für die Mitarbeit
- Marker.io nutzen - Report a bug
- Issue in marker.io
- Issue in git
- Fertig
Workflow
Handbücher bei buchner
Zur Zeit (Stand 02/2021) sind 2 Handbücher in Bearbeitung.
Online-Handbücher
Das Handbuch von Starke Praxis ist unter folgender Adresse einsehbar:
handbuch.buchner.de/starkepraxis
Das Handbuch von Starke Termine befindet sich an folgender Adresse:
handbuch.buchner.de/starketermine
Diese beiden Adressen werden auch den Kunden mitgeteilt. Sie finden hier den letzten fertigen Stand der Handbücher.
Interne Arbeitskopie der Handbücher
Jedes Handbuch hat auch eine Kopie im internen Bereich. An dieser Kopie wird gearbeitet. Hier werden Fehler gesucht und behoben, Wünsche geäußert und Anregungen gegeben.
Der interne Bereich befindet sich unter buchner.io. An den Adressen ist nur die Top-Level-Domain verändert - also statt .de hier .io.
handbuch.buchner.io/starkepraxis und
handbuch.buchner.io/starketermine
Voraussetzungen für die Mitarbeit
Als erstes muss jeder, der Issues für die Handbücher anlegen will, Mitglied des Marker.io-Teams sein.
Danach muss die Marker.io-Erweiterung installiert werden.
Marker.io nutzen - Report a bug
Wichtig: Für alle Seiten des Handbuches, die den Status In Bearbeitung oder In Planung haben, sollten keine Issues erstellt werden.
An den Handbüchern auf buchner.io wird, nach der Installation der Marker.io-Erweiterung, auf der rechten Seite ein roter Reiter angezeigt.
Hinweis: Dieser Reiter wird allerdings nur angezeigt, wenn man bei Marker.io eingeloggt ist.
Mit Klick auf diesen Reiter öffnen sich zwei Layer über der Seite.
Links befindet sich ein Layer mit einem Screenshot der Seite, auf der der rote Reiter geklickt wurde. In diesem Layer kann der Fehler durch einen Pfeil, ein Rechteck oder einen Kreis markiert werden.
Rechts befindet sich der Layer, in dem der Fehler oder die Anregung beschrieben werden kann. Da die Handbücher überschaubar sind, wird es selten Schwierigkeiten geben, den Fehler zu finden, es ist aber durchaus sinnvoll den IST-Zustand zu notieren und zu beschreiben, was stattdessen erwartet wird.
Sehr wichtig ist es, der Aufgabe das richtige Label zu geben.
TODO: Die genaue Nutzung der Label muss hier noch dokumentiert werden.
Wenn das Issue erstellt wurde, gibt es eine kurze Bestätigung.
Issue in marker.io
Durch einen Klick auf Create issue im Marker.io-Label auf der Handbuch-Seite wird eine Aufgabe erstellt, die im Login-Bereich von marker.io zu sehen ist.
https://marker.io/account/login
Nach dem Login, Klick links auf Destinations, dann das entsprechende Handbuch auswählen.
Dort unter Issues.
Diese Aufgaben oder Issues können alle Support-Mitarbeiter einsehen, die einen Marker.io-Zugang haben.
TODO: Aktuell wird ein in git geschlossenes Issue weiter in Marker.io angezeigt. Zu klären wäre, ob das geändert werden kann oder ob es vielleicht sinnvoll ist, dass die Issues solange da stehen bleiben, bis der Ersteller des Issues mit der Bearbeitung zufrieden ist und es manuell löscht.
Hinweis: Der Logout-Button befindet sich unter Settings und dann rechts daneben (zu sehen auf dem Bild mit den Erweiterungen).
Issue in git
Jedes Issue, das in Marker.io erstellt wird, wird automatisch nach git kopiert. Hier steht es den Entwicklern und Autoren zur Verfügung und wird je nach Wichtigkeit bearbeitet.
Nach der Bearbeitung ist die Änderung unter buchner.io zu sehen.
Fertig
Liegt unter buchner.io eine Version vor, die für Kunden freigegeben ist, wird sie mit einem Knopfdruck zu buchner.de kopiert.
Hinweis: Ein Handbuch kann jederzeit für die Kunden freigegeben werden, indem man den Branch develop in den master merged, weil die Kunden nur die fertigen Seiten sehen und durchsuchen können.
Der Label Fertig ist im Kundenhandbuch nicht zu sehen. Alle Seiten, die fertig sind, haben keinen Label.