Scriverò documentazione tecnica chiara, readme, sops e guide API
Direttore senior, integrazioni di architettura di sistemi
Informazioni su questo servizio
Sono un senior software engineer e scrittore pubblicato. Questa combinazione è rara e importante: riesco a leggere il tuo codice, capire cosa fa realmente e spiegarlo chiaramente a chi ne ha bisogno—nuovi sviluppatori, staff operativo, fornitori o dirigenti.
Cosa scrivo:
- Readme e guide di avvio rapido che portano qualcuno da zero a funzionante
- Documentazione API e di integrazione con esempi di codice funzionanti
- SOP, runbook e documentazione di processo per i team di operazioni
- Documenti di onboarding che rendono i nuovi assunti produttivi più velocemente
- Spiegazioni tecniche per stakeholder non tecnici
Perché me: La maggior parte dei technical writer non sa leggere il codice, e la maggior parte degli ingegneri non sa scrivere. Io faccio entrambe le cose. Ho costruito sistemi di produzione in C#/.NET e SQL, guidato progetti di integrazione aziendale e scritto la documentazione che li ha mantenuti in funzione. Testo gli esempi di codice prima di consegnarli.
Riceverai Markdown pulito (o Word/Google Docs), strutturato logicamente, con ogni affermazione accurata rispetto al tuo sistema reale.
Contattami prima di ordinare con il materiale di partenza e il pubblico di destinazione, così confermerò l'ambito e i tempi di consegna.
Lingua:
Inglese
Tipo di contenuto:
Documentazione tecnica
•
Documenti
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.
FAQ
Traduzione automatica.
D: Di cosa ho bisogno per iniziare?
A: Il tuo materiale di partenza — codice, note esistenti, un video walkthrough o anche una bozza di idee — più chi è il pubblico e cosa dovrebbe essere in grado di fare dopo aver letto. Faccio domande di approfondimento invece di indovinare.
Q: Riesci a leggere direttamente il mio codice?
A: Sì. Sono un ingegnere in attività, più fluente in C#/.NET, SQL, Python e JavaScript, e mi sento a mio agio a leggere la maggior parte dei linguaggi abbastanza bene da documentarli con precisione.
Q: Testi gli esempi di codice?
A: Quando l'ambiente lo permette, sì — gli esempi devono compilare ed essere eseguiti come scritto. Se non posso testare qualcosa, te lo dico invece di sperare.
Q: Cosa succede se non so come organizzare il documento?
A: È parte del lavoro. Mandami il materiale grezzo e ti proporrò una struttura prima di scrivere, così siamo d'accordo sulla forma prima che io la riempia.
Q: Mantieni riservatezza sul mio codice e sui dettagli aziendali?
A: Assolutamente. Il tuo materiale viene usato solo per il tuo ordine, mai condiviso o riutilizzato, e lo cancellerò su richiesta.

