Scriverò documentazione tecnica chiara, readme, sops e guide API

Alcune informazioni sono state tradotte automaticamente.

Stati Uniti

Parlo Francese

Direttore senior, integrazioni di architettura di sistemi

Sono un leader ingegneristico con una solida base in diverse piattaforme software, specializzato in soluzioni tecniche per il settore governativo e delle pubbliche relazioni. La mia carriera comprende...
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

Genere:

Gestione degli affari

Istruzione

Diari/Biografie

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.