Domande con tag 'documentation'

domande con tag
3
risposte

Come dovrei documentare uno script Python?

Ho un paio di moduli Python che devono essere eseguiti come script. Come dovrei scrivere le docstrings al modulo e il livello di funzione per rendere chiaro come eseguire e utilizzare il modulo?     
posta 24.08.2011 - 17:17
5
risposte

Come dovrei scegliere la documentazione giusta per il mio team?

Ho chiesto questa domanda qualche giorno fa < a href="https://softwareengineering.stackexchange.com/questions/132991/determining-the-right-amount-of-documentation"> su quanta documentazione dovrebbe essere fatta e ora mi rendo conto che potre...
posta 05.02.2012 - 08:49
7
risposte

È sbagliato non creare Javadoc per il mio codice?

Faccio molta programmazione Java al mio lavoro (sono uno stagista) e mi chiedevo se generalmente è una regola creare javadoc per accompagnare il mio codice. Di solito documento comunque ogni metodo e classe, ma trovo difficile aderire alla sinta...
posta 21.06.2011 - 20:01
2
risposte

Come mantenere la guida dell'utente in linea con le filiali per un non sviluppatore?

La nostra guida per l'utente corrente è creata utilizzando asciidoc . La documentazione è gestita da una persona non tecnica, ma conserviamo i file di testo di origine e HTML generato nel controllo del codice sorgente. I problemi sorgono qua...
posta 14.03.2012 - 19:15
6
risposte

Quanto è complessa la documentazione che scrivi? [chiuso]

In un libro che sto leggendo c'è un capitolo sulla documentazione per il tuo codice. Il libro parla di PHP e descrive alcuni metodi semplici, ma anche alcuni metodi complicati e dispendiosi in termini di tempo (xml, xsl) come DocBook. Alla mi...
posta 29.09.2010 - 23:30
2
risposte

Documentazione eseguibile

Mi piace asciidoc , risp. asciidoctor , a scopo di documentazione. È molto meglio di MS Word e si integra meglio con il controllo del codice sorgente rispetto a strumenti come Confluence. Inoltre, sono a conoscenza degli strumenti che conse...
posta 13.10.2016 - 10:22
2
risposte

Come vengono tracciati i requisiti esistenti nel tempo?

Sono un ingegnere informatico che lavora su un sito Web complesso e in corso. Ha un sacco di parti in movimento e un piccolo team di progettisti dell'interfaccia utente e uomini d'affari che aggiungono nuove funzionalità e modificano quelle vecc...
posta 20.03.2012 - 01:47
3
risposte

Quanto tempo dedichi ai documenti di progettazione per il tuo software?

Ovviamente la dimensione del progetto su cui stai lavorando sarà un fattore importante per quanto tempo dedichi a scrivere il documento / le specifiche di progettazione. Ma passi attraverso tutto, individuando ogni piccolo dettaglio? O hai un ap...
posta 30.09.2010 - 17:34
1
risposta

Come documentare visivamente le interfacce utente interattive per un consumo rapido

Sto scrivendo documentazione per un'interfaccia utente Ajax interattiva, ma invece di scrivere tutto a parole preferisco fornire diagrammi più veloci di interi paragrafi di testo. Ho fornito il diagramma flusso di navigazione della pagina, ma...
posta 22.08.2012 - 18:45
1
risposta

MSDN segue le convenzioni della documentazione per .NET e, in caso affermativo, è pubblicamente disponibile?

Durante la navigazione nella documentazione MSDN per la Libreria di classi .NET Framework (FCL) ho sempre stato stupito da come coerente e completamente documentato. È un compagno costante nello sviluppo di applicazioni .NET. La maggior part...
posta 14.05.2012 - 14:29