Domande con tag 'documentation'

1
risposta

Devo fornire un riferimento al linguaggio oltre a una specifica formale per il linguaggio di programmazione che sto progettando?

Sto progettando un linguaggio di programmazione e vorrei fornire una documentazione completa per questo. Finora, ho programmato di scrivere i seguenti documenti: Uno schema di progettazione iniziale, principalmente per ricordare il desig...
posta 09.05.2012 - 10:42
2
risposte

Comunicazione dell'operazione prevista della logica di business dell'API per gli sviluppatori e gli uomini d'affari

Attualmente sto progettando l'operazione prevista di un'API (RESTful) che un team di sviluppatori alla fine costruirà. Non mi occupo dei dettagli di implementazione, purché gli input siano mappati correttamente alle uscite (e i dati nel database...
posta 21.06.2018 - 21:17
1
risposta

La licenza deve essere in formato testo?

Una licenza software deve essere in formato testo? Sto pensando di adottare la licenza MIT per il mio software. Ho una documentazione in formato HTML, che viene distribuita insieme al software, e sto pensando di includere la licenza all'inizio....
posta 11.03.2016 - 05:04
1
risposta

Come generare materiale didattico dal tuo lavoro [chiuso]

Catalyst: recentemente il mio team è stato incaricato di portare a casa un grande progetto software su cui è stato lavorato per oltre 20 anni. Alcuni dei vecchi team di sviluppo sono ancora in circolazione, e in origine il piano era di farci da...
posta 01.10.2015 - 16:46
1
risposta

L'ordine dei tag phpDocumentor è importante?

Quando documentiamo la nostra classe, metodo e / o funzione con phpDocumentor , c'è un ordine specifico Dovrei seguire secondo gli standard? So che non importa per l'output del documento. Dal momento che sta emettendo l'ordine quello che ho...
posta 16.09.2014 - 11:33
2
risposte

Quanto accuratamente dovresti documentare i flussi di business per un prodotto o un sistema che stai imparando?

Lavoro su applicazioni con documentazione utente ma non è organizzata o aggiornata alla versione corrente. Vale la pena il mio tempo per creare la mia documentazione con schermate e note su tutte le operazioni commerciali attuali che possono...
posta 07.12.2018 - 01:26
2
risposte

Ha senso per le informazioni automatiche raccolte dal sistema legacy

Ho un sistema legacy di cui ho bisogno per pianificare una migrazione. È sviluppato principalmente in Ingres + 4GL (un vecchio sistema di form basato su Ingres). Ho le seguenti informazioni: Strutture dati (relazioni tra database e loro r...
posta 27.11.2017 - 18:02
3
risposte

Metodo preferibile per registrare la documentazione

Come ogni ingegnere del software insegnato sa quanto sia importante la documentazione per i buoni progetti software. Potresti mostrarmi le migliori pratiche per assicurare una buona documentazione a fianco dei commenti di JavaDoc? A mio parer...
posta 24.04.2013 - 22:56
3
risposte

Scrittura di una (utente finale) documentazione [duplicata]

Sto cercando modelli (comuni / astratti) ed esempi per la documentazione del software (utente finale). Mi serve in particolare qualcosa per una "Guida all'installazione", una "Guida operativa" (funzionamento / assistenza / amministrazione del...
posta 04.05.2011 - 09:59
3
risposte

Documenti della specifica dei requisiti

Ho bisogno di lavorare con progetti IT nello sviluppo di sistemi o web per migliorare le mie competenze seguendo le specifiche dei requisiti. Esiste qualche specifica di requisiti disponibile da scaricare per creare un'applicazione?     
posta 26.02.2011 - 10:11