Domande con tag 'documentation'

domande con tag
2
risposte

Esiste una metodologia di sviluppo del software più adatta allo sviluppo di iPhone?

Quale metodo di gestione del progetto e di sviluppo del software è più adatto allo sviluppo di iPhone? Sono disponibili modelli di documentazione che documentano un progetto di sviluppo iPhone?     
posta 16.04.2011 - 06:47
1
risposta

Dove devo specificare i messaggi di convalida?

Sto creando un Functional Specification Document (FSD) per un progetto. Sono abbastanza confuso su dove dovrei specificare i messaggi di errore? Appartengono alla FSD o fanno parte delle Specifiche tecniche (TSD)? Ho letto questi articoli per...
posta 15.07.2018 - 07:44
1
risposta

Documentazione delle variabili in un modulo Python

Sto scrivendo un modulo Python che usa Numpy. Sto cercando di seguire il formato di Numpy docstring . In molte delle mie funzioni, vengono visualizzati gli stessi parametri. Sembra ripetitivo spiegare quali sono in più di una funzione dallo ste...
posta 08.12.2016 - 02:12
1
risposta

Come documentare un software i cui requisiti sono mal gestiti? [chiuso]

Diciamo che ho un prodotto software complesso su cui le informazioni o le conoscenze sono disperse in tutta l'organizzazione che lo ha creato. Ci sono requisiti e caratteristiche su cui anche il reparto Controllo qualità / test non è molto sicur...
posta 07.01.2017 - 15:44
1
risposta

Nome della notazione utilizzata durante la documentazione dei parametri della riga di comando

Spesso, i parametri della riga di comando sono documentati usando una notazione vagamente EBNF-ish come la seguente: L'output di dir /? su Windows: DIR [drive:][path][filename] [/A[[:]attributes]] [/B] [/C] [/D] [/L] [/N] [/O[[:]so...
posta 22.09.2016 - 15:19
2
risposte

Esiste qualche tassonomia / lingua per descrivere le interfacce utente?

Attualmente sto studiando le opzioni che ho, per creare un "sistema di aiuto online". Questo sistema dovrebbe offrire all'utente le informazioni sulle finestre di dialogo, che consistono principalmente in moduli. Quindi la mia domanda princip...
posta 21.02.2013 - 11:34
2
risposte

I collegamenti ripetuti alla stessa classe in un singolo commento di javadoc sono una cattiva pratica?

Attualmente sto scrivendo un'API e la sua documentazione. Ad esempio, ho qualcosa di simile a questo: public interface Event { } public interface Process { } public interface EventProcessor { /** * Starts to process the sepcified ev...
posta 24.05.2013 - 16:00
2
risposte

Che cosa posso utilizzare per generare documentazione API con la mia formattazione personalizzata?

Voglio generare automaticamente la documentazione per un progetto java, ma mi piacerebbe avere il mio stile personalizzato per questo. Ad esempio, prendi la stackoverflow api (pagina descrizione del metodo) , che può essere fatta da uno stru...
posta 08.07.2011 - 21:34
1
risposta

Alternativa alla documentazione POD di Perl in altre lingue?

Perl ha questo metodo di documentazione davvero interessante che semplifica la documentazione. Si chiama POD (Plain Old Documentation) . Ecco un esempio: =head1 NAME Example::Module - an example =head1 SYNOPSIS use Example::Module;...
posta 14.05.2012 - 21:12
1
risposta

Ported Functions Licenze

Ho trovato molte funzioni in python 2.7.2 per essere molto utili e le ho ricreate in C ++ per i miei usi. Come faccio a dare loro un credito Python? Devo anche? Non ho mai veramente guardato i loro codici sorgente. Ho appena scritto delle funzio...
posta 22.07.2013 - 18:51