public-wiki/howto

HowTo

Hier sollen Prozesse die im Reudnetz häufiger passieren dokumentiert werden.

Wann

Immer wenn du irgend eine sache schon mehr als drei mal fürs reudnetz gemacht hast solltest du aufschreiben wie es geht. Das hilft dir selbst keine Fehler bei der Umsetzung zu machen. Das hilft neuen Leuten dabei einfacher ins reudnetz einzusteigen, weil sie nur eine anleitung lesen und niemanden mit Fragen belestigen müssen. (auch wenn du es wahrscheinlich nicht als belestigung empfindest, neulinge sind sich immer etwas unsicher und wollen niemanden nerven) Das hilft dem Reudnetz als Provider-Schablone, weil andere Gruppen uns leichter nachahmen können. Das hilft dem Bus-Faktor, da dein wissen jetzt verfügbarer ist. Das hilft zuletzt auch nochmal dir, weil du so einfacher Aufgaben abgeben kannst.

Wie

Du brauchst:

1. Einen PC
2. einen Texteditor
3. vim
4. git
5. zugriff aufs public wiki
   • direkt oder per pull-request

template.md kopieren

Die Datei template.md beinhaltet ein grobes Anleitungsskellet. Dieses kannst du entweder kopieren dich daran orientieren

Schritt-für-Schritt-Anleitung schreiben

Du schreibst die die Anleitung in kleinen Schritten schreiben, die je isoliert und direkt ausführbar sind. Besser ein paar zu viel Schritte als offene Fragen.

Peer-Review

Geh die Anleitung mit Jemandem durch der den Prozess auch schon mal durchgeführt hat. So könnt ihr gemeinsam eventuelle fachliche Probleme klären.

Not-Yet-Peer-Review

Zeig die Anleitung Jemandem der an dem Prozess interessiert ist, ihn aber noch nicht oder nicht häufig durchgeführt hat. So könnt ihr sicherstellen, dass alles klar beschrieben und verständlich ist.