Ik schrijf sops, standaard operationele procedures, runbooks en procesdocumentatie
Technische documentatie en data automation voor software teams
Over deze dienst
Om drie uur 's nachts leest niemand een wiki-pagina. Ze volgen stappen, of ze improviseren, en improviseren is hoe een klein incident een lang incident wordt.
Ik ben een software engineer. Ik schrijf de procedure die de persoon die paraat staat kan volgen zonder het systeem te kennen.
WAT JE KRIJGT
Wanneer je dit moet uitvoeren, en wanneer niet
Pre-checks: wat te bevestigen voordat je iets aanraakt
Genummerde stappen met de echte commando's, niet een beschrijving ervan
Verificatie: hoe je weet dat het gelukt is
Rollback, of een eerlijke verklaring dat die er niet is
Escalatie: wie je moet wakker maken, en wanneer
WERKT VOOR
Failovers, restores en restarts
Deploys, releases en rollbacks
Onboarding en offboarding
Backups, certificaatvernieuwingen, geplande onderhoudsbeurten
Elke proces dat nu in het hoofd van iemand leeft
HOE HET WERKT
1. Vertel me het proces, of loop het door op een call
2. Ik schrijf het, en geef het terug als een dry run die je kunt testen
3. We passen de stappen aan die ambigu bleken
Als een stap alleen werkt omdat iemand een trucje weet, dan komt dat trucje in het document.
Schrijf me gerust in het Italiaans.
Type document:
Documentatie
•
Standaard werkprocedures
Branche:
Technologie
Taal:
Engels
•
Italiaans
Voorkeur voor een leveringsstijl
Laat het de freelancer weten als je voorkeuren voor of zorgen hebt over het gebruik van AI-tools voor het voltooien en/of leveren van je bestelling.
Mijn portfolio
Veelgestelde vragen
Automatische vertaling
We hebben helemaal geen documentatie. Waar moeten we beginnen?
Met de procedure die het meest zou schaden als de persoon die het weet niet beschikbaar is. Meestal gaat het om een failover, een restore of een deploy. Eén goede runbook is meer waard dan tien half geschreven pagina's.
Heb je toegang nodig tot onze productie systemen?
Nee, en dat zou ik liever ook niet hebben. Een walkthrough call, geredigeerde terminal output en je architectuurnotities zijn genoeg. Je houdt je inloggegevens, ik houd placeholders in het document voor alles dat environment-specifiek is.
In welk formaat krijgen we het, en kunnen we het blijven bewerken?
Markdown, Word, PDF of Confluence-ready HTML, afhankelijk van wat jouw team gebruikt. De bron is van jou, dus je kunt het versiebeheer in Git naast de code die het beschrijft. Ik geef je ook het sjabloon zodat nieuwe procedures overeenkomen.

