Domande con tag 'documentation'

1
risposta

Come modificare le aspettative della documentazione da "gestione del rischio" a "rischio del progetto"

Stiamo cercando di introdurre alcuni concetti agili per gli imprenditori, ma uno dei nostri maggiori ostacoli è la loro aspettativa per la documentazione: la quantità, la paternità / proprietà dei documenti, il ciclo di vita dei documenti, i tem...
posta 04.04.2012 - 14:45
3
risposte

Importanza di diffing e merging per la documentazione delle specifiche di progettazione

Il contesto di questa domanda è la scelta degli strumenti per scrivere le specifiche di progettazione per i progetti software. Questi documenti saranno scritti e gestiti da architetti e sviluppatori, non sto parlando di requisiti di marketing...
posta 23.08.2013 - 01:03
1
risposta

Quando dichiarare @throws con un'annotazione Scala - genitore astratto o implementazione concreta?

In questa domanda StackOverflow ho chiesto del comportamento dell'annotazione @throws in Scala. Ora che capisco come funziona, voglio chiedere delle migliori pratiche con l'utilizzo. Ecco un repost del mio codice da quella domanda: abst...
posta 05.08.2014 - 19:21
4
risposte

Documentazione sull'automazione del test del software

Quali tipi di documenti potrebbero essere utilizzati per descrivere l'automazione del test del software (in qualsiasi fase, pianificazione dell'automazione, progettazione del test, implementazione, reporting)? Esistono tipi standard di documenti...
posta 21.10.2011 - 21:44
3
risposte

Come documentare gli eventi?

La documentazione del codice è in genere correlata a un pezzo di codice, sia esso piccolo (metodo-livello) o più grande (classe o livello di spazio dei nomi). Tuttavia, si tratta sempre degli input e degli output di quel pezzo di codice, pos...
posta 21.02.2013 - 10:42
2
risposte

documentazione del codice di revisione peer [chiuso]

Sappiamo tutti che le revisioni del codice sono generalmente una buona pratica , ma che dire della revisione della documentazione? Molti sviluppatori con cui collaboro pubblicheranno pagine wiki, javadoc, ecc. Ma la maggior parte delle volte, a...
posta 17.01.2015 - 03:20
1
risposta

Esiste un metodo leggero per descrivere i servizi Web, simile a robots.txt o sitemap.xml?

Mi piacerebbe fornire un metodo molto leggero per descrivere i miei servizi web. Nessun WSDL, WADL o materiale complesso simile. Solo una mappatura dall'URL di base del servizio Web a una semplice descrizione che può essere rilevata e analizzata...
posta 18.04.2012 - 11:59
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
3
risposte

Come documentare gli URL e l'interazione tra le pagine

Stiamo sviluppando un'applicazione web che sta ora crescendo fino a poche pagine, tutte con dati complessi e interazioni piuttosto complesse tra le pagine. Ad esempio, il flusso di accesso comprende le seguenti diverse richieste possibili ai...
posta 30.10.2016 - 03:31
3
risposte

Devo seguire un modello di documentazione del progetto open source anche se sono cattivi?

Ho preso in considerazione la possibilità di creare moduli e simili per varie lingue e altre cose open source. Dove la documentazione non è specificata, ma piuttosto è di fatto comune o completamente ad hoc; dovrei provare a migliorare da quello...
posta 16.05.2012 - 20:29