Domande con tag 'documentation'

domande con tag
1
risposta

Come includere documentazione di implementazione e utilizzo in un unico file

Ci sono due tipi di documentazione. Un tipo, la Documentazione di implementazione , contiene informazioni sull'implementazione specifica di un costrutto (ad esempio Classe, Metodo, ecc.). È mirato al futuro me, manutentore, debugger e così v...
posta 11.10.2013 - 15:07
1
risposta

Cosa devo includere nel documento di progettazione OOP?

Sono uno studente laureato in ingegneria aerospaziale. Gran parte della mia tesi di Master è stata dedicata allo sviluppo di un'architettura software OOP in MATLAB per facilitare il controllo di veicoli basati su Arduino (dirigibili, macchine, q...
posta 26.12.2011 - 23:30
0
risposte

Le risorse REST e i tipi di oggetti GraphQL sono concettualmente uguali?

Sono in procinto di delineare la logica aziendale prevista di un servizio web. A questo punto, non sono troppo interessato ai dettagli di implementazione. Al contrario, sto cercando dei modi per astrarli via per descrivere la logica di business...
posta 25.07.2018 - 20:38
0
risposte

Durante la documentazione del codice, dovresti separare lingue diverse in diversi documenti / documenti?

Attualmente sto lavorando a un progetto con centinaia di metodi, l'ho avviato alla cieca senza documentazione e solo ora sto iniziando a inserire la documentazione. Ho 2 lingue principali nel codice, PHP e Javascript. PHP è il mio back-end con f...
posta 04.06.2018 - 03:17
1
risposta

Come strutturare la documentazione di descrizione del processo?

Sto scrivendo un documento che descrive le raccomandazioni per il miglioramento dei processi. Ho alcune buone pratiche che ho imparato finora. Io uso quelle pratiche la maggior parte del tempo. Ma suppongo che ci siano altri modi per affrontare...
posta 16.03.2012 - 11:23
0
risposte

Come migliorare in modo incrementale JavaDocs

Ho iniziato a lavorare in una nuova azienda l'anno scorso. Sono abituato ad avere JavaDoc completi con annotazioni sugli edge case (come quello che succede quando null viene passato al metodo). Sto spingendo per apportare miglioramenti...
posta 01.05.2018 - 23:19
2
risposte

Un wiki di documentazione software interna ha pagine private?

Sto lavorando alla creazione di un software e documentazione del prodotto in un formato wiki. Comprenderà la documentazione per tutti i prodotti dell'azienda. Dopo alcune ricerche, abbiamo deciso di utilizzare la piattaforma MediaWiki e cre...
posta 25.11.2016 - 14:28
0
risposte

Struttura della documentazione nella documentazione del ciclo di vita dello sviluppo del software

Nella creazione di documentazione per il ciclo di vita di un progetto, è meglio avere tutte le decisioni e le scelte (incluse le risorse come le immagini) inserite nello stesso documento, o è meglio modularle? Cioè Per avere ogni decisione e pro...
posta 22.12.2016 - 00:31
0
risposte

Documentazione formale - Casi di assistenza frequenti

Ho il compito di documentare casi di supporto per alcune interfacce, che si verificano su base frequente. Questa documentazione è per gli stakeholder: Sviluppatori per una nuova interfaccia Esportazioni dominio Supporto tecnico La mia...
posta 14.06.2016 - 08:20
1
risposta

Come organizzare il documento software per la stessa applicazione supportando sia iOS che Android

Devo scrivere la documentazione del progetto software per un'applicazione che supporterà sia iOS che Android. Ogni piattaforma ha le sue caratteristiche specifiche e il design e i requisiti dell'app per dispositivi mobili sono quasi gli stessi....
posta 11.02.2014 - 21:46