Ingegneria software documentation

2

Linguaggio Ubiquo - conflitto tra correttezza e usabilità

Una parte fondamentale di Domain Driven Design è l'uso coerente di un linguaggio onnipresente nel sistema: conversazioni, codice, schema del database, interfaccia utente, test, ecc. Sono coinvolto in un progetto in cui esiste già un linguaggio di dominio ben definito, definito da un'organizzazione di standard internazionali. Tuttavia, il lavoro che …

10 documentation domain-specific-languages

13

Sai scrivere una specifica inequivocabile in una lingua naturale come l'inglese?

Mi sembra che non sia possibile scrivere una specifica software in inglese completamente priva di ambiguità, semplicemente a causa della natura informale del linguaggio naturale - e quindi che una specifica veramente inequivocabile deve includere il codice scritto in una lingua specificata formalmente. È un risultato noto o mi sto …

10 documentation specifications

5

Documentazione del codice: pubblica o non pubblica?

Sono uno di quegli sviluppatori che ha la mentalità secondo cui il codice scritto dovrebbe essere autoesplicativo e leggere come un libro. TUTTAVIA, durante lo sviluppo del codice della libreria da utilizzare per altre persone, provo a mettere quanta più documentazione possibile nei file di intestazione; il che fa sorgere …

10 c++ documentation

6

Mi rende un cattivo programmatore se non mi piace la metodologia Agile? [chiuso]

È difficile dire cosa viene chiesto qui. Questa domanda è ambigua, vaga, incompleta, eccessivamente ampia o retorica e non può essere ragionevolmente risolta nella sua forma attuale. Per assistenza per chiarire questa domanda in modo che possa essere riaperta, visitare il centro assistenza . Chiuso 8 anni fa . Mi …

10 agile documentation methodology

5

Buone referenze per esempi di documentazione per l'utente finale e consigli [chiuso]

Chiuso. Questa domanda è fuori tema . Al momento non accetta risposte. Vuoi migliorare questa domanda? Aggiorna la domanda in modo che sia in argomento per Software Engineering Stack Exchange. Chiuso 6 anni fa . Il nostro software interno è stato utilizzato da molti utenti e il dipartimento di formazione …

10 design documentation users

6

Documentazione del codice sorgente esterna, ipertestuale [chiusa]

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 4 anni fa . Perché incorporiamo ancora le descrizioni in linguaggio naturale del codice sorgente …

10 development-process documentation source-code

1

Doxygen supporta i template per l'output HTML?

Ho documentato il mio codice per doxygen, ma non voglio l'HTML predefinito che fornisce. So che posso personalizzarlo fornendo CSS personalizzati, intestazioni, piè di pagina, ecc. (Come fa GNOME) e come posso aggiungere codice PHP comune ai file e dirgli di salvarli come .php, ma non è proprio quello che …

10 documentation templates documentation-generation

1

Come documentare correttamente un algoritmo con dati di esempio?

Mi chiedo cosa dovrebbe contenere una documentazione dell'algoritmo? Impossibile trovare una linea guida adeguata da seguire. Ho in mente di includere riepilogo dell'algoritmo descrizione dell'algoritmo diagrammi di flusso pseudo codici set di dati di input di esempio (multipli) dati di output test unitari esperimenti Il cliente richiede tale documentazione per: …

10 java php algorithms documentation sql

5

Qual è il modo migliore per archiviare la documentazione associata a un progetto di codice?

Abbiamo molti documenti associati allo sviluppo del nostro software. Questi includono cose come requisiti, documenti di progettazione, PDF esterni, file dei clienti, istruzioni per i test, ecc. Attualmente, questi documenti sono sparsi ovunque (wiki, "un posto nella rete", un disco rigido degli sviluppatori locali (!), e posti anche peggiori). Qual …

10 version-control documentation

1

Precisione implicita delle funzioni in virgola mobile

Durante la revisione dell'implementazione di un'altra funzione di un programmatore per calcolare il normale CDF di distribuzione , ho suggerito di sostituire l'intera implementazione con le funzioni integrate di Python o di utilizzare SciPy, una libreria scientifica comune. Un altro programmatore ha sottolineato che né math.erfc()né scipy.stats.norm.cdf()fornisce alcuna garanzia di …

9 documentation math floating-point numeric-precision

3

È una cattiva pratica aggiungere collegamenti esterni nella documentazione?

Spesso mi trovo a risolvere i bug trovando la risposta su Stack Overflow. È una cattiva pratica aggiungere uno snippet del motivo per cui ho fatto quello che ho fatto e quindi aggiungere un collegamento a un articolo o una pagina dal web?

9 documentation

1

Come mantenere aggiornati gli esempi di codice in javadocs

Sto lavorando a una piccola libreria che fornisce implementazioni di metriche di stringa di base ben note. Principalmente per la mia educazione. Quindi lo sviluppo avviene ogni volta che ho un po 'di tempo libero. Per questo motivo ho automatizzato la maggior parte dei processi in modo da poter rilasciare …

9 java documentation javadocs

4

Dovremmo cercare il codice bugiardo?

Questo si riferisce a una discussione in una risposta e ai commenti di questa domanda: che cosa è l'avversione alla documentazione nel settore? . La risposta affermava che "il codice non può mentire" e quindi dovrebbe essere la posizione di riferimento anziché la documentazione. Diversi commenti hanno sottolineato che "il …

9 documentation

3

Come fare riferimento a specifiche aree di codice nella documentazione?

Sto per lasciare un progetto e prima di andare il mio capo mi ha chiesto di documentare il codice (non ho documentato molto bene). Non è un grosso problema, il progetto non è terribilmente complesso. Ma sto trovando posti nella mia documentazione in cui vorrei dire: "Avviso sulla linea XYZ …

9 documentation comments

3

Come tenere traccia di regole aziendali complesse al di fuori del codice?

Sono interessato a vedere come fanno gli altri. Soprattutto nelle situazioni in cui più client diversi utilizzano la stessa base software con regole aziendali leggermente diverse. Che tipo di pratiche usi per documentare come tutto dovrebbe funzionare o regole aziendali. Fondamentalmente, quindi, quando arriva un nuovo sviluppatore, il team ha …

9 documentation business-rules

Domande taggate «documentation»