Scriverò e verificherò il tuo README di github rispetto al repository

Alcune informazioni sono state tradotte automaticamente.

Regno Unito

Parlo Inglese

Specialista in Ricerca Tecnica e Fact Checking

Ricercatore tecnico e specialista in documentazione orientato alle evidenze. Trasformo bozze generate dall'AI e materiali tecnici complessi in contenuti supportati da fonti, pronti per la pubblicazion...
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