Scriverò documentazione API, guide utente, guide all'installazione
Ti aiuto a sistemare siti web e a spiegare la tecnologia in modo chiaro
Informazioni su questo servizio
Hai difficoltà a spiegare il tuo prodotto, API o software a utenti e sviluppatori? Trasformo informazioni tecniche complesse in documentazione chiara e facilmente consultabile che viene effettivamente usata, non ignorata o abbandonata.
Cosa scrivo:
Documentazione API - documenti REST API, riferimenti endpoint, esempi di request/response, guide all'autenticazione
Guide utente - guide di onboarding, walkthrough delle funzionalità, articoli how-to, contenuti per knowledge base
Guide all'installazione e configurazione - istruzioni passo passo, requisiti di sistema
Documentazione di troubleshooting - FAQ, guide diagnostiche, documenti per risolvere problemi comuni
File README - file README.md su GitHub per progetti open-source o interni, inclusi istruzioni di setup, esempi di utilizzo e linee guida per i contributori
Perché lavorare con me:
- La documentazione è scritta per completare il task, non per quantità di parole: ogni documento risponde a "cosa devo fare dopo?"
- Strutturata per la consultazione: intestazioni, passaggi numerati, blocchi di codice e tabelle dove servono
- Seguo guide di stile esistenti (o aiuto a crearne una se non ne hai)
Ideale per: startup SaaS, prodotti API-first, progetti open-source, strumenti per sviluppatori e qualsiasi team di software che ha bisogno di documentazione che un utente può seguire senza dover scrivere email al supporto.
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: Devo fornire dettagli tecnici o puoi ricercare il mio prodotto da solo?
R: Posso lavorare in entrambi i modi. Se mi dai accesso al prodotto, documenti esistenti o una chiamata per spiegarmi, raccoglierò io stesso i dettagli tecnici. Se preferisci, puoi darmi solo appunti approssimativi o una demo funzionante, e io farò ricerche e ti porrò domande chiarificatrici se necessario.
D: In quale formato consegnerai la documentazione finale?
R: Word/Google Docs, HTML o direttamente sulla tua piattaforma (Notion, GitBook, ecc.) — qualunque sia il tuo flusso di lavoro. Fammi sapere la tua preferenza prima di iniziare.
