Domande con tag 'documentation'

domande con tag
5
risposte

Un documento di descrizione dell'architettura è una violazione del principio di DRY?

Il principio DRY (Non ripeterti) afferma che "ogni conoscenza deve avere un singolo , rappresentazione non ambigua e autorevole all'interno di un sistema. " La maggior parte delle volte si riferisce al codice, ma spesso viene esteso anche alla...
posta 09.10.2010 - 21:34
5
risposte

Quali sono i deliverable da fornire al client per un'applicazione web? [chiuso]

Ho completato un'applicazione web che è fondamentalmente sviluppata in PHP ed è solo un'altra normale applicazione web. Di solito quando consegna la versione finale della produzione, passo semplicemente a consegnare la documentazione del codice...
posta 01.09.2011 - 16:24
7
risposte

Ogni programmatore dovrebbe tenere un diario "Lessons Learned"? [chiuso]

Ogni volta che ho finito un progetto, c'è sempre qualcosa che ho imparato (altrimenti non trovo molto motivante). Ma non riesco a ricordare tutto, e molto più tardi potrei incappare nello stesso problema che ho incontrato in un precedente proget...
posta 01.03.2011 - 12:54
1
risposta

che tipo di sistema di documentazione tecnica online consiglieresti? [chiuso]

l'obiettivo è avere un sistema di documentazione online, con questi requisiti principali: sarà utilizzato principalmente come fase intermedia per i documenti tecnici finali di tutte le nostre applicazioni (che probabilmente non saranno mai c...
posta 20.01.2011 - 12:08
4
risposte

Come vengono scoperte le funzioni non documentate? [chiuso]

Mi sono sempre chiesto come trovi l'API non documentata / privata Esempio di Apple API non documentata / privata, Play Station , Windows Phone 7 , Win32 Kernel , < em> API di Windows , callback nascosto , ecc. Quali strumenti usan...
posta 29.01.2011 - 16:18
5
risposte

Modelli / requisiti della proposta di progetto [chiuso]

Quando progetti una proposta di progetto, usi un modello standard? Quali caratteristiche / informazioni dovrebbero essere incluse? Cosa è bello aver incluso? Che tipo di informazioni sulla piastra della caldaia devo inserire? Trovi qualche...
posta 22.09.2010 - 19:13
3
risposte

Scrittura di proposte di software di alta qualità [chiuso]

Recentemente ho letto alcune proposte di progetti software e sono un po 'preoccupato per quello che ho visto. Spesso sento che le proposte sono state affrettate e / o mal concepite. È molto probabile che le proposte non abbiano bisogno di sem...
posta 17.05.2011 - 00:58
1
risposta

Esistono studi empirici sugli effetti del commentare il codice sorgente sulla qualità del software, sulla manutenibilità e sulla produttività degli sviluppatori? [chiuso]

Sono un sostenitore di commentare il codice sorgente e documentare i prodotti software. È mia personale esperienza e osservazione che lavorare su un codice sorgente rigorosamente commentato mi ha aiutato in diversi modi quando ho dovuto sviluppa...
posta 20.02.2013 - 15:00
1
risposta

Lo sviluppo iterativo della documentazione è possibile e fornisce una documentazione efficace?

Ho un progetto per l'università che non inizierò immediatamente, ma ho pensato per un periodo di tempo abbastanza lungo. Capisco che lo sviluppo di un progetto universitario non è come l'industria (attualmente sono uno stagista) quindi la situaz...
posta 16.01.2012 - 08:22
6
risposte

I commenti sono considerati una forma di documentazione?

Quando scrivo piccoli script per me stesso, impilo il mio codice in alto con i commenti (a volte commento più del codice I). Molte persone con cui parlo dicono che dovrei documentare questi script, anche se sono personali, così che se mai li ven...
posta 14.05.2012 - 02:06