Scriverò documentazione tecnica, readme e API docs per il tuo progetto
Automazione AI e sviluppatore full stack
Informazioni su questo servizio
Il tuo progetto funziona. Il problema è che nessuno può iniziare a usarlo senza chiederti prima tre domande.
Sono uno sviluppatore full-stack, quindi leggo il tuo codice prima di scriverne. Non devi spiegarmi il tuo progetto riga per riga.
COSA OTTIENI
- Un README che risponde alle quattro domande in ordine: cos'è, come si installa, come si esegue, cosa fare quando si rompe
- Passaggi di installazione che ho effettivamente seguito, con prerequisiti e versioni reali, non supposizioni
- Ogni variabile di ambiente in una tabella: cosa fa, richiesta o meno, un esempio sicuro
- Riferimento API con metodo, percorso, autenticazione, parametri, una richiesta reale e una risposta reale
- Ogni codice di errore che il tuo servizio può restituire e cosa dovrebbe fare il chiamante a riguardo
- Esempi eseguibili in curl e JavaScript, testati piuttosto che illustrativi
STACKS CHE LEGGO COMODAMENTE
JavaScript, TypeScript, React, React Native, Node.js, Express, PostgreSQL, Supabase, flussi di lavoro n8n, REST e webhook.
Consegnato come Markdown, pronto per il commit, o come sito di documentazione nel pacchetto Premium. Scrivo in inglese e in portoghese brasiliano, e posso consegnare entrambe le versioni dello stesso documento.
Tipo di documento:
Documentazione
•
Specifiche tecniche
Settore:
Software
Lingua:
Inglese
•
Portoghese
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.
Devo spiegarti tutto il mio codice?
No. Dammi accesso al repository o un zip, e lo leggerò. Tornerò con una breve lista di domande solo dove il codice non può rispondere da solo.
Il mio codice è confidenziale?
Sì. Non riutilizzo, pubblico o condivido il codice del cliente, e sono felice di firmare un NDA prima che tu invii qualsiasi cosa.
Puoi documentare un'API privata o interna?
Sì. Se c'è una raccolta (Postman, Insomnia, OpenAPI), inviala. Se non c'è, leggo le route.
Puoi scrivere sia in inglese che in portoghese?
Sì. Richiedi la consegna bilingue e ricevi entrambe le versioni dello stesso documento.

