Scriverò e verificherò il tuo README di github rispetto al repository
Specialista in Ricerca Tecnica e Fact Checking
Informazioni su questo servizio
La maggior parte dei README sembra curata ma fallisce al primo comando.
Esaminerò il tuo repository e trasformerò la sua documentazione in una guida rapida che un nuovo utente può seguire effettivamente. A seconda del pacchetto, io:
- mappo le vere prerequisiti, installazioni, percorsi di esecuzione e test;
- eseguo comandi sicuri in uno spazio di lavoro locale pulito quando possibile;
- correggo nomi di file obsoleti, versioni, variabili di ambiente ed esempi;
- separo il comportamento verificato da supposizioni o servizi non disponibili;
- miglioro la struttura, Markdown, risoluzione dei problemi e guida ai contributori; e
- restituisco un log di verifica che mostra cosa è passato, fallito o non testabile.
Ideale per strumenti open-source, piccole librerie, CLI, API e progetti di sviluppatori.
L'IA può assistere con la mappatura del repository, ma i comandi e le affermazioni sui materiali vengono verificati rispetto al codice fornito e agli output. Non invento risultati di test.
Non incluso: malware o codice offuscato, comandi distruttivi, deployment in produzione, sistemi di cui non possiedi i diritti, certificazioni di sicurezza o segreti. Contattami prima di ordinare se il progetto richiede servizi a pagamento, hardware insolito o una build di grandi dimensioni.
Tipo di documento:
Documentazione
•
Specifiche tecniche
Settore:
Software
Lingua:
Inglese
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.
Ti limiti a ridisegnare il README?
No. Miglioro la scrittura e il layout, ma il vero valore aggiunto è la verifica basata sul repository rispetto al codice fornito e agli output dei comandi sicuri.
Quali linguaggi e tipi di progetto accetti?
Python, JavaScript, TypeScript, PHP e progetti web o CLI comuni sono i più adatti. Contattami prima per lavori su mobile, nativi, GPU, embedded o hardware dipendente.
Ogni comando verrà eseguito?
Solo comandi sicuri, riproducibili localmente e entro i limiti del pacchetto. Percorsi con credenziali, servizi a pagamento, hardware speciale e in produzione sono contrassegnati come non testati con la motivazione.
Hai bisogno di accesso al repository?
Di solito basta un URL di repository pubblico o un ZIP fornito dall'acquirente. Non inviare password, token, chiavi private, dati dei clienti o credenziali di produzione.
Puoi aggiungere badge e diagrammi?
Posso aggiungere strutture utili, veritiere e diagrammi semplici dove il scope lo permette. Non aggiungerò badge il cui stato non può essere verificato.
Usi l'intelligenza artificiale?
L'IA può aiutare a mappare i file e confrontare la documentazione con il codice. Il lavoro finale è personalizzato e revisionato, e nessun risultato di successo viene rivendicato a meno che non sia stato osservato.

