Domande con tag 'documentation'

domande con tag
2
risposte

Manutenzione e documentazione degli endpoint API di molte applicazioni in un'architettura di microservizio

Penso che uno dei più grandi punti dolenti nel lavorare con i microservizi sia assicurarsi che le API siano ben documentate e che le API non cambino il loro comportamento senza influenzare le applicazioni a valle. Questo problema si amplifica qu...
posta 23.01.2018 - 19:27
6
risposte

Quanto sono utili i punti di funzione? [chiuso]

Quanto è utile misurare i punti funzione ? Utilizziamo i punti funzione nel mio nuovo lavoro. Ho sentito parlare di punti funzione ma non ho avuto alcuna formazione o esperienza ... ma non ho molta fiducia in cose che non possono essere spie...
posta 24.12.2010 - 17:53
1
risposta

Come rappresento un diagramma schema del mio database MongoDB?

Ho un database MongoDB che voglio documentare correttamente la progettazione dello schema. So che MongoDB è un database NoSQL ed è senza schemi per natura, ma applico uno schema attraverso la mia applicazione e voglio rappresentarlo in modo migl...
posta 03.11.2015 - 19:45
2
risposte

Mantiene la versione della documentazione uguale alla versione del progetto

Oltre a questa domanda Git deve essere utilizzato per la documentazione e la gestione dei progetti? Il codice dovrebbe essere in un repository separato? Voglio chiedere se è consigliabile mantenere la versione della documentazione (ad esempi...
posta 27.03.2017 - 23:15
1
risposta

Esiste un documentor standard di fatto per Javascript?

Sto provando a documentare il mio codice usando JSDOC3, che ha una sintassi simile a PHPDocumentator / Apigen. Ma esiste uno standard de facto per la documentazione in linea di Javascript? Penso che Google Closure sia il più completo (o almeno c...
posta 02.05.2013 - 17:46
4
risposte

Come classificare le informazioni nella documentazione per l'utente finale?

Uno dei più grandi pezzi di documentazione che abbia mai letto è the TeXbook di Donald Knuth, il manuale del sistema di composizione TeX , e l'ho usato nella mia prima analisi . Per quanto posso dire, il tipo di informazioni trasmesse dall...
posta 24.11.2013 - 18:06
10
risposte

Come chiamo le persone che estendono la mia classe nella documentazione della classe base?

Sono stati definiti "implementatori", ma a me sembra strano. /// <summary> /// Implementers should implement this. Derp /// </summary> protected abstract void InternalExecute(); Un punto di chiarimento, mi interessa sapere come...
posta 23.11.2010 - 17:41
6
risposte

Qual è il modo migliore per dimostrare che la documentazione in codice è superiore alla documentazione esterna estesa?

Qual è il modo migliore per dimostrare al mio capo che nella documentazione del codice è maggiore di ampi documenti esterni contenenti documentazione e schermate di codice / ui? Abbiamo un gruppo nella società che esegue il codice SAP. Il lor...
posta 22.04.2013 - 18:48
4
risposte

checklist per la consegna del lavoro [duplicato]

Ho rassegnato le dimissioni dal mio vecchio datore di lavoro per iniziare un nuovo lavoro, e ho bisogno di preparare un passaggio di consegne [la documentazione deve essere presa da qualche nuovo dipendente che non è ancora arrivato, e ci vorr...
posta 02.08.2011 - 02:02
8
risposte

Come gestire la documentazione funzionale?

La nostra documentazione funzionale / commerciale è distribuita su file Word sulla nostra intranet aziendale. È difficile trovare e aggiornare le informazioni. Ci deve essere un modo migliore. Qualche idea? Avevamo pensato che un Wiki avrebbe...
posta 19.12.2011 - 16:47