Domande con tag 'documentation'

domande con tag
0
risposte

Come devo affrontare la generazione della documentazione per la mia libreria FOSS? [chiuso]

Ho pubblicato una piccola libreria FOSS (link sotto, ma quello che fa non è molto materiale per questa domanda), su GitHub. Non ha ancora versioni, ma è abbastanza utilizzabile e (sorta) testato. Ora, ho un robusto documento in prima pagina p...
posta 17.11.2016 - 16:46
0
risposte

Puntatori condivisi su thread in UML per diagrammi di classi e sequenze

Come si rappresentano i puntatori condivisi tra i thread in UML per diagrammi di classi e diagrammi di sequenza? In particolare, desidero documentare la proprietà della memoria anche se è accessibilità (un puntatore / riferimento) potrebbe sp...
posta 10.06.2016 - 16:32
0
risposte

Devo usare RFC 2119 nella documentazione dell'interfaccia?

RFC 2119 definisce diversi termini, tra cui MUST, DOVREBBE e MAY, per l'uso in documenti standard, in particolare quelli relativi a protocolli di rete come IP e HTTP. Questi termini sono ampiamente utilizzati nelle RFC per descrivere il livell...
posta 14.04.2016 - 19:27
0
risposte

C'è un buon modo per creare una sezione FAQ all'interno di un markdown README.md [closed]

Ho un piccolo progetto in cui voglio inserire le FAQ nella pagina principale di README.md senza dovermi confrontare con la formattazione manuale di esso e idealmente con le sezioni di compressione per semplificare la scansione delle domande senz...
posta 26.10.2015 - 09:33
1
risposta

Documentazione dell'API JSON MVC

Ho un'applicazione MVC5 che stiamo utilizzando un'API JSON per vari client (app mobili, altre applicazioni Web, ecc.) e un'applicazione web tradizionale. Le azioni del controllore che restituiscono i dati JSON sono quelle che fanno parte dell'AP...
posta 08.05.2015 - 16:57
0
risposte

Scala / SBT - Documentazione delle modifiche alla configurazione per le versioni

Sto cercando di raccogliere diversi modi di gestire la configurazione su più ambienti. Ho l'obbligo di documentare le modifiche alla configurazione per il piano di implementazione. I valori di sviluppo sono valori predefiniti nel codice e QA...
posta 15.05.2014 - 16:41
5
risposte

Parametri di output con nome e valori di ritorno

Quale codice è migliore: // C++ void handle_message(...some input parameters..., bool& wasHandled) void set_some_value(int newValue, int* oldValue = nullptr) // C# void handle_message(...some input parameters..., out bool wasHandled) voi...
posta 27.06.2013 - 14:54
3
risposte

Qual è la necessità di un libro di cucina invece di avere solo un manuale di riferimento? [chiuso]

Quali suggerimenti vorresti fare per scrivere un libro di cucina per utilizzare un database distribuito? L'obiettivo finale tangibile è sufficiente per distinguere un libro di cucina da un documento di riferimento? Cos'altro dovrei prendere in c...
posta 28.02.2017 - 17:34
2
risposte

Devo includere una spiegazione sul framework utilizzato in una documentazione del programmatore?

Nel mio intership ho usato il framework D3.js per visualizzare i dati, ora alla fine dello stage scriverò una documentazione sul progetto nel suo complesso. Solo poche persone nel mio team sono state coinvolte nel progetto. Nessuno di loro...
posta 30.09.2016 - 10:13
2
risposte

Come documentare le funzioni setter autoesplicative? [duplicare]

Spesso i setter booleani sono piuttosto auto-esplicativi, come setLogErrors($bool) . Vedo alcuni vantaggi nel fornire alcune informazioni aggiuntive nella documentazione, in questo caso forse dove vengono registrati questi errori. Ma quant...
posta 26.02.2014 - 06:26