Domande con tag 'documentation'

domande con tag
1
risposta

Ci sono differenze tra Funzionalità e Requisiti Funzionali [chiuso]

Sto scrivendo della documentazione in un progetto in uno strumento. In questo mio strumento, e scrivo in un'area specifica, qui uso Case, Business Rule, N-Diagram, e Funzionalità e requisiti funzionali. Quindi mi sono chiesto, ci sono differe...
posta 09.01.2013 - 20:35
3
risposte

C'è una differenza tra proprietà e attributo?

Queste due parole sono completamente sinonimi per me, ma mi chiedo se ci sia effettivamente una differenza semantica utile che posso incorporare in convenzioni / processi di codifica / denominazione.     
posta 04.10.2011 - 23:18
3
risposte

Come decidi quanti documenti di requisiti aziendali hai bisogno e come strutturarli? [chiuso]

Negli ultimi due anni, ho lavorato su due progetti. Il primo, abbiamo usato una metodologia molto agile. È stato molto guidato dagli sviluppatori. In quanto tale, i cambiamenti sono stati molto rapidi e rapidi. La qualità del codice era alta...
posta 25.09.2013 - 05:28
1
risposta

Maturity Guida per l'utente, documentazione e framework PHP di facile apprendimento

Sono all'inizio di un progetto a lungo termine con uno sviluppo continuo. Per questo motivo spero di prendere una buona decisione in merito a quale Framework sarà giusto per questo. In precedenza ho lavorato con Codeigniter. Un plusside è l'e...
posta 22.05.2013 - 08:31
1
risposta

Ci sono elementi comuni a quasi tutti gli SRS?

Un SRS è una graffetta di ogni serio lavoro a contratto, e può essere incredibilmente noioso per coloro che non hanno mai avuto la sfortuna di doverne leggere uno in una volta. Sto scrivendo una serie di classi di documenti con LaTeX (lingu...
posta 19.06.2013 - 01:31
2
risposte

Come si scrive una definizione di prodotto software?

Vorrei imparare come scrivere una definizione di prodotto software. Pertanto, sto cercando materiali o libri online che mi aiutino a saperne di più su questo argomento. Mi piacerebbe imparare, per cominciare: cosa deve essere incluso in tale...
posta 29.06.2011 - 22:31
1
risposta

Come documentare i kwarg in stile Sfinge?

Mi chiedo come posso documentare **kwargs in Python usando lo stile di sforzare lo sfarfallio. Ad esempio, ho il seguente metodo e voglio documentare maggiori dettagli su kwargs. def get(self, url=None, **kwargs): """ InsReq...
posta 12.04.2018 - 13:23
1
risposta

Gli esempi di utilizzo nella documentazione XML dovrebbero essere testati esplicitamente?

Se gli esempi di utilizzo sono forniti nella documentazione XML, questi esempi dovrebbero essere esplicitamente testati? /// <summary> /// Gets a collection of Foo objects. /// </summary> /// <param name="bar">The model data...
posta 25.07.2017 - 19:30
1
risposta

È appropriato utilizzare le sezioni docstring 'return' e 'args' per specificare gli stati HTTP ei parametri URL?

Sto lavorando a un progetto di applicazione web che utilizza Tornado come front-end web. Attualmente sono in procinto di scrivere documenti e aggiungere docstrings al codice base con Pydoc. Come framework API per le applicazioni, le applica...
posta 07.02.2017 - 09:07
3
risposte

Definire l'allocazione delle risorse nella documentazione del metodo

Voglio scrivere una libreria con la funzione "nessuna garanzia di perdita di risorse". Quindi saprò se ogni metodo assegna o meno una risorsa. Potrebbe cambiare il codice. Ad esempio: void foo() { methodDontAllocateAnyResources(); methodCa...
posta 07.01.2015 - 10:23