Domande con tag 'documentation'

domande con tag
1
risposta

Quando e perché durante la reingegnerizzazione del software a volte la ricostruzione del documento viene saltata?

Mentre studiavo il libro di Ingegneria del software dell'autrice Roger Pressman, mi sono imbattuto in questo punto sulla reingegnerizzazione del software, in cui è scritto nel libro che se la creazione di documentazione richiede molto tempo, all...
posta 15.10.2017 - 11:08
2
risposte

Design documento per progetto in C

Ho avuto una certa esperienza nella documentazione del progetto per il progetto sviluppato in linguaggi OOP. Ho creato classi e ho utilizzato diagrammi di classe per mostrare la struttura generale di progettazione dell'implementazione quando ho...
posta 13.09.2013 - 19:33
2
risposte

E 'una cattiva pratica avere docstring aggiornato dinamicamente?

Quando creo una docstring, a volte voglio fare riferimento a un valore, ad esempio: def try_download(data, path): """Tries to download ATTEMPTS times, catching socket errors.""" Dove ATTEMPTS è solo una costante int definita all'in...
posta 04.08.2016 - 18:48
2
risposte

Come leggere la documentazione dell'API? [chiuso]

Ho cercato di leggere l'API RoR per cercare di imparare le cose che il tutorial ha mancato, e non sono stato in grado di seguirlo affatto. L'unica volta che ho letto la documentazione è stato quando ho avuto bisogno di cercare un modulo Python,...
posta 18.08.2012 - 17:45
1
risposta

Come si scrive direttamente alla documentazione del punto senza sembrare trascurati e informali?

Sono attualmente in una posizione contrattuale e sto cercando di aggiungere alla documentazione dei progetti su cui ho lavorato, per aiutare il prossimo assunto a rilevare i miei progetti. La documentazione che ho ricevuto era eccessivamente...
posta 22.11.2011 - 16:49
4
risposte

XML o HTML per Manuale utente / Guida e perché?

Voglio creare Manuale utente / Aiuto per il mio programma. Ho trovato due buoni modi - XML o HTML - che dovrei usare e perché? So come farlo in html (so come usare js, css e così via) ma in XML è più difficile (o immagino?) comunque quale...
posta 27.10.2011 - 17:47
1
risposta

Un migliore JavaDoc? [chiuso]

Il modello standard JavaDoc (Doclet) non è cambiato molto fino al recente JDK7. A mio parere, il modello JDK7 ha reso ancora più difficile la navigazione. Ho esaminato diversi doclet di terze parti, ma nessuno è quello che voglio. Così ho inizia...
posta 24.10.2012 - 14:59
3
risposte

Formalizzare una specifica dei requisiti scritta in inglese narrativo

Ho una specifica di requisiti di funzionalità piuttosto tecnica, espressa in prosa inglese, prodotta dal mio project manager. È strutturato come una raccolta di schede dell'interfaccia utente, in cui i requisiti per ciascuna scheda sono espressi...
posta 14.12.2012 - 09:53
2
risposte

Includere i difetti interni nelle note di rilascio?

Quando si consegna un prodotto, le note di rilascio contengono chiaramente i problemi noti rilevati dal cliente nella build precedente. Ma dovremmo includere i difetti che noi, come fornitori, abbiamo trovato durante i nostri test, quelli irriso...
posta 13.12.2014 - 17:38
2
risposte

Il modo migliore per delimitare gli elementi variabili di un percorso nella documentazione del codice?

Spesso alcuni elementi di un percorso sono variabili, ma il percorso nel suo insieme deve essere documentato in qualche modo per i programmatori successivi. Soprattutto quando si usano i sistemi * nix, quasi tutti i caratteri sono un simbolo val...
posta 11.10.2010 - 23:52