Domande con tag 'documentation-generation'

domande con tag
1
risposta

Esiste un documentor standard di fatto per Javascript?

Sto provando a documentare il mio codice usando JSDOC3, che ha una sintassi simile a PHPDocumentator / Apigen. Ma esiste uno standard de facto per la documentazione in linea di Javascript? Penso che Google Closure sia il più completo (o almeno c...
posta 02.05.2013 - 17:46
5
risposte

Come si tiene traccia del significato dei propri campi SQL? [chiuso]

Più campi SQL aggiungo alle mie tabelle e più chiavi primarie / estranee aggiungo più mi manca la panoramica per campi specifici per determinati scenari come Ottieni / Aggiungi / Elimina / Aggiorna dati. Uso SQL Management Studio (SQL Server)...
posta 11.07.2012 - 09:44
1
risposta

documentazione del codice dattiloscritto [chiuso]

la mia domanda è piuttosto breve: Come posso documentare correttamente il codice dattiloscritto? Ho scoperto che per i progetti sempre più grandi, è importante guardare a una funzione e conoscere immediatamente i parametri, cosa restituisce e...
posta 19.01.2013 - 14:32
1
risposta

Rappresentazioni di risorse e strumenti di documentazione dell'API REST

Non mi sento sicuro di cosa significhi esattamente avere rappresentazioni diverse di una risorsa RESTful. L'esempio canonico prevede che un'API fornisca un endpoint, ad esempio /v1/users/:id , e consente al client di selezionare la migliore...
posta 05.01.2016 - 03:00
2
risposte

Ricerca di consigli sulla documentazione del sistema

Ho un motore di valutazione (è fondamentalmente un algoritmo) che quando ho iniziato non aveva documentazione formale. Abbiamo creato una specifica / scomposizione funzionale che è il nostro documento di livello aziendale, ma ora ho bisogno di q...
posta 30.10.2012 - 12:46
1
risposta

Come si può migliorare il processo di creazione e manutenzione della documentazione?

So che è una domanda molto soggettiva, ma questa è una sezione di Ingegneria del Software in cui non ho visto alcun miglioramento in termini di come possiamo farlo in un modo migliore. Immagino che ogni programmatore faccia documentazione con qu...
posta 16.02.2011 - 14:20
2
risposte

Come faccio a seguire DRY durante la documentazione della struttura dei moduli e delle interfacce?

In questo documento , è consigliabile che un documento sia il seguente: struttura del modulo interfacce modulo Se sto scrivendo le strutture e le interfacce del modulo dettagliate in un documento autonomo, non sto ripetendo il lavoro c...
posta 26.04.2011 - 22:28
6
risposte

Diagramma che potrebbe spiegare il codice di una macchina di stato?

Abbiamo molti concetti per fare diagrammi come UML e diagrammi di flusso o semplicemente creare qualsiasi combinazione di scatole e frecce al momento, ma sto guardando un diagramma visivo su qualcosa che in realtà è veramente complesso. Le...
posta 19.11.2011 - 23:56
3
risposte

Quali potrebbero essere alcune insidie nell'introduzione di una guida di stile e di un software di generazione di documentazione in un team di sviluppo?

Sto considerando l'utilizzo di appledoc , un aroma di Doxygen da utilizzare nella generazione della documentazione del codice Objective-C, in per creare documentazione per le app iOS della mia azienda. L'idea è che un server genererà i document...
posta 05.11.2011 - 04:32
2
risposte

Usando i bdd-gui-test automatici per fare in modo che la schermata della documentazione degli utenti faccia la data?

Ci sono sviluppatori là fuori, che (ab) usano la funzione CaptureScreenshot() dei loro gui-test automatizzati per creare anche screenshot uptodate per la documentazione utente? Sfondo: nella vita di un'applicazione, i suoi elementi chiav...
posta 29.06.2011 - 11:37