Documenterò il tuo software con diagrammi di architettura e documenti swagger openapi
Sviluppatore Full Stack
Informazioni su questo servizio
BASE: 1 modulo, panoramica del progetto, struttura, guida all'installazione e 1 diagramma di architettura. Consegna in Markdown.
STANDARD: fino a 3 moduli, flussi di lavoro chiave e modello di dati, fino a 3 diagrammi e Swagger/OpenAPI per 10 endpoint. Markdown e PDF.
PREMIUM: fino a 6 moduli, flussi di lavoro dettagliati e modello di dati, fino a 6 diagrammi e OpenAPI per 25 endpoint. Guida all'installazione/deploy basata sulle informazioni del tuo ambiente. Markdown, PDF e fonti modificabili dei diagrammi.
Un modulo è un'area funzionale concordata, come autenticazione o pagamenti. Un endpoint è un metodo HTTP più route. Tutti i limiti si applicano insieme a un repository e a una versione di codice concordati.
Le revisioni coprono correzioni all'interno dell'ambito e della versione di codice concordati. Nuove funzionalità, modifiche al codice, test runtime e aggiornamenti continui richiedono un preventivo separato. Contattami prima di ordinare per progetti grandi o complessi.
FAQ
Traduzione automatica.
di cosa hai bisogno per iniziare?
Fornisci il codice sorgente o il repository, linguaggio/framework, versione di codice concordata, numero di moduli e endpoint, destinatari previsti e informazioni disponibili su installazione/deploy. Rimuovi password, API key e dati personali prima di condividere.
Usi AI per creare la documentazione?
Sì. Utilizzo analisi assistite da AI per preparare la documentazione e rivederla rispetto al codice e alle informazioni fornite. Comportamenti mancanti o poco chiari saranno segnalati per chiarimenti. Il testing runtime è un servizio separato.
Cosa si intende per modulo o endpoint?
Un modulo è un'area funzionale concordata, come autenticazione o pagamenti. Un endpoint è un metodo HTTP e una route. I limiti del pacchetto si applicano insieme a un repository e a una versione di codice. Sistemi più grandi richiedono un'offerta personalizzata.
Cosa è incluso nelle revisioni?
Le revisioni coprono correzioni e chiarimenti all'interno dell'ambito e della versione di codice concordati. Nuovi moduli, funzionalità, modifiche al codice, ulteriori endpoint o aggiornamenti continui della documentazione richiedono un preventivo separato.

