Domande con tag 'documentation'

4
risposte

Che cos'è un "piano di implementazione"? [chiuso]

Mi è stato recentemente assegnato il compito di creare un documento del piano di implementazione. Quando ho chiesto un esempio di quello che potevo vedere, mi è stato detto di guardare il piano di progetto che era già stato creato come base. Son...
posta 14.06.2012 - 00:31
6
risposte

Come utilizzare i test unitari come fonte di informazioni?

Un mio collega è stato a un seminario sullo sviluppo agile, dove ha sentito che è possibile utilizzare i test unitari come documentazione tecnica. Qualcosa come utilizzare i test unitari come esempio di come usare la classe. Una rapida ricerc...
posta 16.05.2012 - 20:09
5
risposte

Come evitare che le modifiche a un'API interna interrompano altri progetti?

Abbiamo 20-30 moduli / soluzioni indipendenti. Ognuno di questi ha circa 7 - 10 progetti con classi, componenti, ecc. Questi sono tutti utilizzati internamente alla nostra azienda. Il nostro problema è quando apportiamo una modifica in un mod...
posta 17.09.2015 - 13:14
3
risposte

Esiste un riferimento Django?

Sono nuovo di Django. Ho trovato le guide tematiche ufficiali link un luogo eccellente per imparare da. Ma ora sono in un posto in cui ho bisogno di un rapido riferimento per vedere quali metodi ha un oggetto, quali argomenti richiede, cosa re...
posta 20.10.2011 - 13:31
5
risposte

Ho il compito di guidare lo sforzo di documentazione per un prodotto software esistente, del tutto privo di documenti, quali risorse ci sono per aiutarmi?

Sono uno sviluppatore di software presso un'azienda tecnologica. Sono stato incaricato di guidare lo sforzo di documentazione per il prodotto su cui lavoro. L'obiettivo è produrre documentazione interna allo sviluppatore, e il progetto si rivers...
posta 18.02.2011 - 00:28
5
risposte

Come bilanciare i requisiti della documentazione con gli sviluppi Agile [duplicato]

Nel nostro gruppo di sviluppo sono attualmente in corso discussioni sulla metodologia agile e waterfal. Nessuno ha alcuna esperienza pratica con agile, ma stiamo facendo un po 'di lettura. Il manifesto agile elenca 4 valori: Individui e...
posta 06.03.2011 - 01:40
4
risposte

Le migliori pratiche per contrassegnare un metodo che viene chiamato tramite riflessione?

Il nostro software ha diverse classi che dovrebbero essere trovate dinamicamente tramite la riflessione. Le classi hanno tutte un costruttore con una firma specifica tramite la quale il codice di riflessione crea un'istanza degli oggetti. Tutta...
posta 24.04.2017 - 15:48
3
risposte

Documentazione di un'interfaccia REST con un diagramma di flusso

Qualcuno ha suggerimenti sulla creazione di una rappresentazione del diagramma di flusso di un web in stile REST interfaccia? Nell'interesse di fornire una documentazione approfondita ai co-sviluppatori, ho cercato di modellare l'interfaccia per...
posta 27.07.2011 - 17:49
1
risposta

Documentazione del codice Java in un file docs separato mappato in qualche modo su un file sorgente?

Quale sarebbe una buona alternativa alla documentazione in linea Java, cioè si può avere un file docs separato in qualche modo mappato su un file sorgente java? Non mi sono mai piaciute le sezioni di commenti enormi disseminate nel codice.  ...
posta 29.10.2012 - 14:03
6
risposte

Documentazione sul codice sorgente con collegamento ipertestuale e [chiuso]

Perché incorporiamo ancora descrizioni in linguaggio naturale del codice sorgente (cioè, la ragione per cui perché è stata scritta una riga di codice) all'interno del codice sorgente, piuttosto che come documento separato? Dato l'ampio spaz...
posta 19.09.2013 - 05:52