Scriverò una readme chiara e una guida all'installazione per il tuo progetto web
Audit del sito web con esperienza in web e SEO dal 2020
Informazioni su questo servizio
Tipo di documento:
Documentazione
Settore:
Software
Lingua:
Olandese
•
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.
FAQ
Traduzione automatica.
Quanto può essere grande il mio progetto?
Tutti i pacchetti coprono un progetto con fino a 5 file sorgente/configurazione rilevanti e 500 righe non vuote in totale. File del fornitore, generati e minificati sono esclusi dalla revisione. Pacchetti superiori aumentano la profondità della documentazione, non la dimensione del repository. Invia la lista dei file e la stack prima così posso confermare l'idoneità.
Cosa includono i limiti di parole ed esempi?
Base include una README fino a 800 parole e un esempio di utilizzo. Standard include fino a 1400 parole totali e 3 esempi. Premium include fino a 2000 parole totali e 5 esempi. Questi sono limiti massimi, non obiettivi fittizi; i documenti possono essere più corti se chiariscono bene il progetto.
Eseguirai il mio progetto o documenterai qualche linguaggio di programmazione?
Concordiamo prima su uno stack supportato, una versione e un ambiente locale. Verifico passi sicuri entro lo scope; niente codice pericoloso, segreti o servizi a pagamento. Dipendenze mancanti e passi non verificati sono registrati chiaramente. Non prometto ogni tecnologia o sistema operativo.
Rifarai bug, distribuirai il progetto o scriverai una documentazione completa dell'API?
No. Documenterò la versione concordata e fornirò note di verifica. Riparazioni di codice, nuove funzionalità, deployment, accesso in produzione, siti di reference API completi, revisioni di sicurezza e ambienti extra sono esclusi. Problemi esistenti possono essere documentati senza dichiarare che sono stati risolti.
Puoi usare codice privato e usi l'IA?
Condividi solo codice autorizzato e rimuovi segreti e dati personali. L'IA può aiutare nella stesura; io valido manualmente la documentazione rispetto al sorgente e ai test permessi. Il codice sorgente e materiale non pubblico non vengono inviati a IA esterne senza consenso scritto preventivo. Concorda in anticipo come gestire materiale riservato.
Quali file, lingue e revisioni ricevo?
File Markdown modificabili, un sommario delle modifiche e note di verifica, in inglese o olandese. Una revisione copre correzioni o chiarimenti per la versione originale, file, esempi e ambiente. Nuove versioni, funzionalità o ambienti richiedono un accordo separato.

