Scriverò SOP, procedure operative standard, runbook e documentazione dei processi
Documentazione tecnica e automazione dei dati per team di sviluppo software
Informazioni su questo servizio
Alle tre del mattino nessuno legge una pagina wiki. Seguono i passaggi, o improvvisano, e improvvisare è come un piccolo incidente diventa lungo.
Sono un ingegnere del software. Scrivo la procedura che la persona di turno può seguire senza conoscere il sistema.
COSA OTTIENI
Quando eseguire questa procedura e quando no
Pre-controlli: cosa confermare prima di intervenire
Passaggi numerati con i comandi reali, non una descrizione di essi
Verifica: come sapere se ha funzionato
Rollback o una dichiarazione onesta che non ce n'è
Escalation: chi svegliare e quando
FUNZIONA PER
Failover, ripristini e riavvii
Deploy, rilasci e rollback
Onboarding e offboarding
Backup, rinnovo dei certificati, manutenzione programmata
Qualsiasi processo che oggi vive nella testa di una persona
COME FUNZIONA
1. Raccontami il processo o guidami in una call
2. Lo scrivo, poi te lo restituisco come una prova a secco che puoi testare
3. Sistemiamo i passaggi che si sono rivelati ambigui
Se un passaggio funziona solo perché qualcuno conosce un trucco, quel trucco entra nel documento.
Scrivimi pure in italiano.
Preferenza per lo stile di consegna
Informa il freelance di eventuali preferenze o preoccupazioni relative all'uso di strumenti di IA nel completamento e/o nella consegna dell'ordine.
Il mio portfolio
FAQ
Traduzione automatica.
Non abbiamo documentazione affatto. Da dove iniziamo?
Con la procedura che sarebbe più dannosa se la persona che la conosceva fosse indisponibile. Di solito si tratta di un failover, un ripristino o un deploy. Un buon runbook vale più di dieci pagine scritte a metà.
Hai bisogno di accesso ai nostri sistemi di produzione?
No, e preferirei non averla. Una call di walkthrough, output del terminale redatto e le note sulla tua architettura sono sufficienti. Mantieni le credenziali; io tengo i placeholder nel documento per tutto ciò che è specifico dell'ambiente.
Che formato otteniamo e possiamo continuare a modificarlo?
Markdown, Word, PDF o HTML pronto per Confluence, a seconda di quello che usa il tuo team. La fonte è tua, quindi puoi versionarla in Git insieme al codice che descrive. Ti do anche il template affinché le nuove procedure siano coerenti.

