Creerò documentazione per sviluppatori e API per il tuo saas
Scrittore tecnico, ingegnere della documentazione API per prodotti AI e SaaS
Informazioni su questo servizio
Il tuo prodotto merita una documentazione che funzioni davvero, non solo una che esiste.
Sono un technical writer e DevRel engineer che scrive riferimenti API, guide per sviluppatori e documentazione di prodotto per aziende SaaS e strumenti di sviluppo. Non mi limito a descrivere la tua API da una scheda tecnica, la testo direttamente, colgo le lacune e gli errori che altri scrittori ignorano e scrivo documenti che gli sviluppatori possono seguire senza bloccarsi.
Ciò che porto:
- Test API dal vivo prima di scrivere anche una sola riga, così la documentazione rispecchia ciò che il tuo prodotto fa realmente
- Struttura chiara: titoli, esempi e FAQ organizzati nel modo in cui gli sviluppatori scansionano, non come scrivono i marketer
- Esperienza con GitBook, Markdown e documentazione REST API
- Formazione in AI/ML, così posso spiegare i concetti tecnici con precisione, non solo in modo plausibile
Ho documentato interfacce API complete per automazioni browser e prodotti SaaS, creato guide di stile per la coerenza tra grandi set di documenti e scritto contenuti di onboarding che hanno migliorato in modo misurabile l'adozione da parte degli sviluppatori.
Se vuoi una documentazione che riduca i ticket di supporto invece di generarli, parliamone. Mandami un messaggio con i dettagli del tuo prodotto o API e ti dirò esattamente come posso aiutarti.
Lingua:
Inglese
•
Altro
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.
Hai bisogno di accesso al mio prodotto o API per scrivere la documentazione?
Sì, idealmente. Testo API e flussi di prodotto direttamente prima di scrivere, perché così catturo errori che altri scrittori ignorano. Se l'accesso non è possibile, posso lavorare dai tuoi specifici o dalla documentazione esistente.
Con quali strumenti e formati lavori?
Scrivo in Markdown e lavoro direttamente in GitBook, Notion, Confluence o Word/Google Docs, a seconda di cosa usa il tuo team. Posso anche adattarmi a una guida di stile esistente o aiutarti a crearne una se necessario.
Puoi scrivere documentazione da zero o solo modificare documenti esistenti?
Entrambe le cose. Scrivo nuova documentazione da una pagina bianca e revisiono e riscrivo documenti esistenti che sono obsoleti, poco chiari o incoerenti.
Come funzionano le revisioni?
Ogni pacchetto include un set di revisioni che coprono modifiche a struttura, chiarezza e accuratezza. Richieste oltre il scope originale, come nuove pagine o cambiamenti di argomento, sono considerate un nuovo servizio o extra.
Cosa succede se il mio prodotto cambia dopo aver consegnato la documentazione?
Sono felice di fare aggiornamenti continui come servizio separato. Se prevedi cambiamenti regolari, scrivimi e possiamo impostare un contratto mensile semplice.
Firmi NDA?
Sì. Lavoro regolarmente con prodotti in fase iniziale e API pre-lancio, e sono disponibile a firmare un NDA prima di rivedere materiali riservati.
