Domande con tag 'documentation'

4
risposte

Che cosa comprende esattamente "Documentazione"?

Quando diciamo "documentazione" per un prodotto software, che cosa include e cosa non dovrebbe includere? Ad esempio, una domanda recente ha chiesto se i commenti sono considerati documentazione? Ma ci sono molte altre aree per cui quest...
posta 16.05.2012 - 06:52
3
risposte

Come si leggono RFC e documenti simili? [chiuso]

RFC : Request for Comments (RFC) is a memorandum published by the Internet Engineering Task Force (IETF) describing methods, behaviors, research, or innovations applicable to the working of the Internet and Internet-connected systems...
posta 11.12.2012 - 12:16
4
risposte

Come gestire la documentazione di un progetto open source? [chiuso]

Sono il creatore di un crescente progetto open source. Attualmente, sto diventando frugato cercando di capire il modo migliore per gestire la documentazione. Ecco le opzioni che ho considerato: Sito Web HTML Un Wiki di Github File di Mar...
posta 14.07.2011 - 20:42
5
risposte

Alternativati alla Guida HTML

Al momento utilizziamo un sistema chiamato AsciiDoc che ci consente di creare documentazione in un semplice markup di testo. Da ciò possiamo generare più formati di output. Utilizziamo solo i formati di output pdf e chm. Mi stavo chiedendo...
posta 22.10.2011 - 13:36
5
risposte

Che cos'è "Dominio del problema"

Devo documentare il mio programma per un progetto scolastico e abbiamo una sezione chiamata "dominio del problema", ma non ho idea di cosa discutere in questa sezione. Quindi la domanda è: cosa dovrebbe essere discusso nel dominio del problem...
posta 19.12.2011 - 12:28
9
risposte

Studi su guadagni / perdite di produttività della documentazione del codice

Dopo molte ricerche, non sono riuscito a rispondere a una domanda di base relativa a una presunta nota nel mondo dello sviluppo software: COSA È NOTO: Applicare una politica rigorosa su una documentazione di codice adeguata (che si tratti...
posta 01.02.2011 - 20:22
6
risposte

È possibile giustificare la creazione di un documento di progettazione software dopo lo sviluppo?

Attualmente sto lavorando alla mia laurea per i miei studi di "Sviluppo software", in cui devo sviluppare software complessi singolarmente in un'azienda esterna. Tutto ciò deve essere fatto in modo strutturato, creando tutti i documenti corrispo...
posta 04.06.2018 - 12:37
4
risposte

Come documentare e insegnare agli altri il codice computazionalmente intensivo "ottimizzato oltre il riconoscimento"?

Occasionalmente c'è l'1% di codice che è abbastanza intensivo dal punto di vista computazionale che richiede il tipo più pesante di ottimizzazione a basso livello. Esempi sono l'elaborazione video, l'elaborazione delle immagini e tutti i tipi di...
posta 24.11.2011 - 02:40
9
risposte

Documentazione del codice Prima? [chiuso]

Qualcuno ha mai provato a creare una documentazione completa del codice prima di scrivere effettivamente il codice? Ci stavo pensando prima, perché pensavo che sarebbe stato utile scrivere un'interfaccia concreta e assicurarmi che il tuo progett...
posta 17.03.2011 - 20:25
3
risposte

Come documentare API sperimentali o incomplete come @deprecated?

Esiste un termine valido che è simile ma diverso da "deprecate" per indicare che un metodo o un'API si trova nella base del codice ma non dovrebbe essere utilizzato perché la sua implementazione non è completa o probabilmente cambierà? (Sì, lo s...
posta 15.10.2012 - 21:38