Domande con tag 'documentation'

domande con tag
6
risposte

Devo aggiungere note MSDN o collegamenti Stack Overflow al codice sorgente? [duplicare]

Sto creando un host PowerShell / C # e voglio aggiungere il seguente commento // This method cannot be called multiple times on a given pipeline. The state of the // pipeline must be NotStarted when Invoke is called. When this method is c...
posta 11.02.2012 - 16:33
5
risposte

Le specifiche funzionali fanno parte delle specifiche dei requisiti di sistema?

Mi chiedo, fonti come wikipedia o modelli che ho trovato mostrano che le specifiche funzionali sono una parte dei documenti dei requisiti di sistema. Ho sempre pensato che SRD sia solo una descrizione generale del sistema, con tutti i requisit...
posta 07.12.2012 - 11:58
4
risposte

La documentazione utente include gli screenshot? [duplicare]

Questa domanda si concentra sulla documentazione utente , non sulla documentazione del codice. Ho appena finito il mio progetto software, e le persone per cui lavoro mi aspettano che scriva la documentazione dell'utente, descrivendo tutto...
posta 16.09.2013 - 15:18
2
risposte

C'è qualcosa di peculiare in Matlab o Mathworks che supporta così tanto codice "non documentato"?

Recentemente ho studiato molto Matlab cercando di interfacciarmi con il lavoro di un ingegnere dell'algoritmo interno per modularizzarlo per l'uso in un banco di prova al di fuori della sua suite di applicazioni. Ho trovato molti collegamenti da...
posta 17.06.2015 - 01:23
9
risposte

Impostazione di un ambiente di sviluppo

Io faccio parte di un'organizzazione che sta formalizzando i propri processi / capacità di sviluppo del software / ecc. Sebbene l'organizzazione non sia tradizionalmente una organizzazione di software, vogliono fare questo e fornire agli svilupp...
posta 27.04.2011 - 17:09
2
risposte

È irragionevole scrivere la documentazione dell'utente nello stile di un libro tecnico?

Dimmi se ti sembra familiare: something something something... as seen in figure 1-1 on the next page... In praticamente tutti i libri che ho letto sulla programmazione. Così quando stavo scrivendo un piccolo opuscolo didattico su come u...
posta 20.10.2010 - 23:55
5
risposte

Qual è l'importanza del documento di visione e di come aiuta lo sviluppo?

Sono uno sviluppatore che lavora da solo, e recentemente, cercando i tipi di documenti che posso ancora trarre beneficio, anche se non ho bisogno di nulla di formale, ho letto che un documento che è ancora altamente raccomandato per scrivere è i...
posta 12.01.2017 - 01:11
1
risposta

Dividere la documentazione tra docstring e sfinge

Sto usando una combinazione di docstring e Sphinx per documentare i miei programmi Python. Con l'autodoc di Sphinx, posso scrivere molta documentazione nel sorgente come docstring. C'è uno standard per la quantità di documentazione da inserire i...
posta 24.01.2013 - 03:51
4
risposte

Le specifiche funzionali sono un "documento di progettazione"?

Quindi sono stato un po 'perso nei termini, quindi prima di tutto vi presento quello che ho imparato finora: Specifiche dei requisiti di sistema: cosa vogliono gli utenti, cosa dovrebbe fare il sistema Requisito funzionale: in che modo le cose,...
posta 27.07.2012 - 17:27
4
risposte

Tutti gli sviluppatori di un team hanno lo stesso ruolo / responsabilità nella scrittura e nell'aggiornamento dei documenti di progettazione del software

Ho fatto una domanda molto simile qualche giorno fa, ma poiché presentavo troppa situazione attuale della mia azienda, la maggior parte delle risposte si concentrava completamente su qualcosa a cui non stavo cercando di rispondere. Quindi volevo...
posta 09.10.2011 - 07:40