Domande con tag 'documentation'

domande con tag
3
risposte

come impaginare buona documentazione [chiuso]

Ho bisogno di scrivere una documentazione per gli sviluppatori per poter usare un software web API come devo creare una documentazione? Cosa dovrebbe essere sempre incluso? E deve essere davvero lungo o essere il più semplice e semplice possibil...
posta 18.11.2011 - 18:00
3
risposte

Come documentare il flusso del programma in modo che il risultato sia professionale? [chiuso]

Ho progettato un semplice sito Web su carta. Ora voglio produrre un documento dall'aspetto professionale che il mio cliente possa approvare. Come posso fare questo? Ho provato Visio, ma sembra terribilmente complicato e inadatto al mio sco...
posta 08.08.2013 - 18:08
1
risposta

Devo eseguire il backup dei file di implementazione in una mia libreria, oltre alle intestazioni?

Sono in procinto di scrivere commenti Doxygen per questa mia biblioteca; è una libreria di intestazione, in gran parte C ++, ma ha un codice che viene collegato anziché incluso. Per quel codice, che ha intestazioni .h / .hpp - dovrei aggiunge...
posta 28.03.2017 - 21:51
1
risposta

Comprensione dei livelli dei casi d'uso

Ho scoperto che ci sono 5 livelli di casi d'uso: Livello 0 Cloud Level 1 Kite Livello 2 Mare Livello 3 pesci Level 4 Clam Livello cloud elenca solo gli obiettivi di utenti di livello elevato come "Gestisci file". Livello aqu...
posta 23.01.2018 - 09:19
1
risposta

Documentazione delle interfacce

So come documentare una funzione: /** * Prints a greet message to the web page */ function greet() { echo "Hi!"; } O descrivi l'uso di una variabile: /** * @type string $name The user's name */ $name = "Bas"; Ma non so come doc...
posta 17.01.2015 - 17:04
3
risposte

Come considerare la funzione di login che raccoglie i requisiti di un'applicazione? è un requisito dell'utente?

Sto lavorando su un'applicazione che si aspetta che l'utente effettui il login all'avvio dell'applicazione (come ad esempio in Skype: l'utente apre l'applicazione e gli appare una maschera di login quando inserisce username e password per inizia...
posta 06.01.2014 - 12:45
3
risposte

Documentazione: che cosa è "appropriato" quando si esprime un intervallo valido per un parametro?

Qual è il metodo appropriato per descrivere un intervallo valido di un parametro nella documentazione del codice? Ovviamente la documentazione di lunga durata (white paper, documenti API, ecc.) Può essere più prolissa del codice reale, ma questo...
posta 01.08.2011 - 23:24
2
risposte

prototipazione rapida nella progettazione e nello sviluppo di progetti

al momento sto lavorando a un progetto nel mio tempo libero (principalmente 3-4 ore da lunedì a venerdì e fino a 6 ore la domenica) e ho trovato redmine molto utile per tenere traccia delle attività di sviluppo. Tuttavia, ci sono alcune cose,...
posta 11.07.2011 - 03:52
1
risposta

Metriche: commenti vs API documentata

Mi è stato chiesto di eseguire alcune metriche del codice per valutare la qualità del codice. Una delle metriche è stata vagamente specificata come "commenti". Ho eseguito Sonar sul mio codice, e mentre ho ottenuto il 10% sulla metrica "comme...
posta 28.06.2011 - 19:07
1
risposta

Le specifiche tecniche del prodotto sono ancora rilevanti? [chiuso]

Recentemente ho avuto una conversazione con un reclutatore. Come ingegnere di contratto, ho lavorato diversi anni nel corso degli anni ed è passato molto tempo da quando ho visto una specifica formale. Pagine di confluenza, sì. Oggetti di Jira,...
posta 30.11.2018 - 18:09