Ich erstelle SOPs, Standard Operating Procedures, Runbooks und Prozessdokumentationen
Technische Dokumentation und Datenautomatisierung für Softwareteams
Über diesen Service
Um drei Uhr morgens liest niemand eine Wiki-Seite. Sie folgen Schritten oder improvisieren, und Improvisation ist der Grund, warum aus einem kleinen Vorfall ein langer wird.
Ich bin Softwareingenieur. Ich schreibe die Prozedur, die die Person im Einsatz befolgen kann, ohne das System zu kennen.
WAS DU BEKOMMST
Wann man das ausführt und wann nicht
Pre-Checks: Was vor der Berührung überprüft werden muss
Nummerierte Schritte mit den echten Befehlen, nicht nur einer Beschreibung
Verifizierung: Wie du weißt, dass es funktioniert hat
Rollback oder eine ehrliche Aussage, dass es keinen gibt
Eskaliation: Wen du wecken sollst und wann
FÜR
Failovers, Wiederherstellungen und Neustarts
Deployments, Releases und Rollbacks
Onboarding und Offboarding
Backups, Zertifikatsverlängerungen, geplante Wartungen
Jeder Prozess, der heute im Kopf einer Person lebt
WIE ES FUNKTIONIERT
1. Erzähl mir den Prozess oder führe mich per Anruf durch ihn
2. Ich schreibe ihn und gebe ihn dir als Trockenlauf zurück, den du testen kannst
3. Wir korrigieren die Schritte, die sich als mehrdeutig herausgestellt haben
Wenn ein Schritt nur funktioniert, weil jemand einen Trick kennt, kommt dieser Trick in das Dokument.
Schreib mir ruhig auf Italienisch.
Dokumenttyp:
Dokumentation
•
Standard Operating Procedures (SOPs)
Branche:
Technologie
Sprache:
Englisch
•
Italienisch
Bevorzugte Lieferart
Bitte informiere den Freelancer über alle Präferenzen oder Bedenken in Bezug auf den Einsatz von KI-Tools bei der Ausführung und/oder Lieferung deines Auftrags.
Mein Portfolio
FAQ
Automatische Übersetzung
Wir haben überhaupt keine Dokumentation. Wo fangen wir an?
Mit dem Verfahren, das am meisten schadet, wenn die Person, die es kennt, nicht verfügbar ist. Meistens ist das ein Failover, eine Wiederherstellung oder ein Deployment. Ein gutes Runbook ist mehr wert als zehn halbfertige Seiten.
Brauchst du Zugriff auf unsere Produktionssysteme?
Nein, und ich hätte es auch lieber nicht. Ein Walkthrough-Anruf, redaktionell bearbeitete Terminal-Ausgaben und deine Architektur-Notizen reichen aus. Du behältst deine Zugangsdaten; ich lasse Platzhalter im Dokument für alles, was umgebungsspezifisch ist.
In welchem Format erhalten wir es, und können wir es weiter bearbeiten?
Markdown, Word, PDF oder Confluence-kompatibles HTML, je nachdem, was dein Team benutzt. Die Vorlage gehört dir, sodass du sie in Git versionieren kannst, zusammen mit dem Code, den sie beschreibt. Ich gebe dir auch die Vorlage, damit neue Verfahren einheitlich sind.

