Ingegneria software documentation

1

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

Chiuso . Questa domanda è basata sull'opinione . Al momento non accetta risposte. Vuoi migliorare questa domanda? Aggiorna la domanda in modo che possa essere risolta con fatti e citazioni modificando questo post . Chiuso 6 anni fa . l'obiettivo è disporre di un sistema di documentazione online, con i …

11 documentation

5

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

Il principio DRY (Don't Repeat Yourself) afferma che "ogni pezzo di conoscenza deve avere una rappresentazione unica, inequivocabile e autorevole all'interno di un sistema". Il più delle volte questo si riferisce al codice, ma spesso viene esteso anche alla documentazione. Si dice che ogni sistema software abbia un'architettura che tu …

11 agile documentation architecture dry

5

Modelli / requisiti della proposta di progetto [chiuso]

Allo stato attuale, questa domanda non è adatta al nostro formato di domande e risposte. Ci aspettiamo che le risposte siano supportate da fatti, riferimenti o competenze, ma questa domanda probabilmente solleciterà dibattiti, argomenti, sondaggi o discussioni estese. Se ritieni che questa domanda possa essere migliorata e possibilmente riaperta, visita …

11 project-management business management documentation

4

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

Il nostro software ha diverse classi che dovrebbero essere trovate dinamicamente tramite la riflessione. Tutte le classi hanno un costruttore con una firma specifica tramite la quale il codice di riflessione crea un'istanza di oggetti. Tuttavia, quando qualcuno verifica se si fa riferimento al metodo (ad esempio tramite Visual Studio …

11 c# .net documentation reflection

6

I commenti sono considerati una forma di documentazione?

Quando scrivo piccoli script per me stesso, impilo il mio codice in alto con commenti (a volte commento più di quanto codice). Molte persone con cui parlo affermano che dovrei documentare questi script, anche se sono personali, in modo che se mai li vendessi, sarei pronto. Ma i commenti non …

11 documentation comments

3

Scrivere commenti java doc per casi di test unitari

A mio avviso, i casi di test unitari servono come documentazione per il codice. La mia azienda vuole che scriva commenti dettagliati su java doc in cima ai casi di test unitari. È necessario farlo? Scrivi commenti del genere?

11 unit-testing documentation

4

Includere un collegamento alla documentazione pertinente nel messaggio di errore?

Creiamo una libreria commerciale ed esempi di codice che vengono utilizzati da sviluppatori esterni. Abbiamo una documentazione (chiusa, disponibile per gli utenti registrati) che spiega ampiamente come utilizzare la libreria. Molti sviluppatori sono utenti principianti, quindi si verificano molti errori rudimentali. È appropriato includere collegamenti alla documentazione nel registro degli …

10 documentation api-design error-handling error-messages

4

Esiste uno standard per documentare l'architettura di alto livello di un programma?

Sono uno sviluppatore dilettante e fino ad ora tutti i miei programmi erano abbastanza semplici da essere documentati nel codice. Durante la lettura del codice è stato chiaro cosa stavo facendo così e tale azione (il mio test standard era quello di guardare il codice 6 mesi dopo e capire …

10 architecture documentation

5

Utilizzo di modelli diversi per funzioni simili

Sono l'unico sviluppatore di un progetto che, come per qualsiasi progetto software, potrebbe essere preso da qualcun altro in futuro. Diciamo che ho usato il modello X per implementare la funzione A. Dopo aver sviluppato e finito la funzione, mi rendo conto di poter implementare la stessa funzione usando il …

10 design-patterns refactoring documentation

1

Quali informazioni dovrebbero essere contenute nel file README.md di github?

Quali informazioni ti aspetteresti di vedere nel file README di github? Tutto dovrebbe andare nel README? vale a dire introduzione Installazione versioni Guida utente Implementazione analisi Risorse correlate O dovresti semplicemente inserire alcune cose nel README (Introduzione, Installazione, Versioni) e le altre informazioni si trovano nel wiki di Github?

10 documentation github

3

I commenti XML sono necessari documentazione?

Ero un fan del richiedere commenti XML per la documentazione. Da allora ho cambiato idea per due motivi principali: Come il buon codice, i metodi dovrebbero essere autoesplicativi. In pratica, la maggior parte dei commenti XML sono rumori inutili che non forniscono alcun valore aggiuntivo. Molte volte usiamo semplicemente GhostDoc …

10 .net programming-practices development-process documentation comments

5

È una buona idea scrivere le specifiche dei requisiti in base alle storie?

Al momento stiamo usando metodi agili nel mio progetto attuale e abbiamo un sacco di storie come queste: Come assistente, voglio pagare un rimborso a un cliente in modo che possano ottenere dei soldi quando lo richiedono Come cliente, desidero pagare un acquisto in modo da poter ricevere il mio …

10 agile documentation requirements user-story

5

Determinare la giusta quantità di documentazione

Dove attualmente lavoro l'approccio generale è - evitare la documentazione il più possibile Documenta solo se una squadra diversa ne avrà bisogno solo per chiarimenti, non intendo la documentazione in codice - questo lo facciamo, intendo tutta la documentazione che circonda il processo di progettazione - se si tratta di …

10 documentation

5

Modo migliore per addestrare nuovi assunti [chiuso]

Chiuso . Questa domanda deve essere più focalizzata . Al momento non accetta risposte. Vuoi migliorare questa domanda? Aggiorna la domanda in modo che si concentri su un problema solo modificando questo post . Chiuso 5 anni fa . Il team al momento faccio parte di un fatturato abbastanza elevato, …

10 documentation training

5

Un commento di metodo dovrebbe includere sia un sommario che una descrizione di ritorno quando sono spesso così simili?

Sono un sostenitore del codice adeguatamente documentato e sono ben consapevole dei possibili aspetti negativi di esso . Questo è al di fuori dell'ambito di questa domanda. Mi piace seguire la regola di aggiungere commenti XML per ogni membro pubblico, considerando quanto mi piace IntelliSense in Visual Studio. Esiste tuttavia …

10 documentation comments intellisense

Domande taggate «documentation»