Scriverò un readme chiaro e una guida di configurazione per il tuo progetto

Un nuovo collaboratore può iniziare il tuo progetto senza chiedere cosa fare dopo?

Trasformerò il tuo repository e i passaggi di configurazione verificati in un README o una guida di setup chiara che un'altra persona può seguire.

La tua documentazione può includere:

scopo e obiettivi del progetto

prerequisiti e ambiente supportato

passaggi di installazione

nomi delle variabili di ambiente senza valori segreti

comandi di esecuzione, build e test

risultati di verifica attesi

note di troubleshooting

limiti noti e incognite chiaramente indicate

Verificherò le istruzioni fornite rispetto al progetto fornito, ove possibile, e separerò i passaggi verificati da quelli basati su supposizioni.

Per favore, fornisci il repository o i file rilevanti, il tuo attuale README se disponibile, i passaggi effettivi di setup/esecuzione/test, le versioni supportate di OS e runtime, e il risultato atteso. Rimuovi password, chiavi API, dati personali e tutti gli altri segreti prima di inviare.

Questo servizio copre la documentazione e la verifica limitata. Non include deployment in produzione, una rifattorizzazione completa del codice, un audit di sicurezza formale o una garanzia che ogni ambiente si comporterà allo stesso modo.