Domande con tag 'documentation'

domande con tag
3
risposte

Esistono prove formali che la documentazione in generale sia incompleta e obsoleta rispetto ad un certo grado? [chiuso]

Sono uno sviluppatore web e attualmente mi trovo ancora una volta in una situazione in cui un reparto op in parte clueless richiede una documentazione "completa" necessaria per il supporto tecnico della nostra applicazione da parte di una terza...
posta 01.04.2014 - 14:42
1
risposta

Chi scrive una specifica funzionale in una società di software? [chiuso]

Chi scrive le specifiche funzionali in una società di software? Data una società di software in genere comprende ingegneri software, responsabili di progettazione, responsabili di prodotto e direttori?     
posta 18.02.2018 - 07:27
2
risposte

Come dovrebbero essere utilizzate le docstring nei moduli con una classe?

Quando si crea il codice OOP, a volte si ha un file che contiene solo una classe e nient'altro. PEP8 dice che tutti i moduli e tutte le classi dovrebbero avere docstring che delineano quello che fanno. Ma in questo caso, il modulo è semplicem...
posta 22.10.2018 - 04:38
1
risposta

Quali sono le categorie più cruciali di contenuti da organizzare in un portale per sviluppatori interno in una grande azienda? [chiuso]

Mi è stato affidato l'incarico di organizzare tutto il contenuto interno dell'azienda attualmente distribuito su sharepoint, un manuale di riferimento di markdown e confluenza in un singolo portale coesivo e utilizzabile in confluenza. Voglio ch...
posta 05.09.2013 - 19:33
2
risposte

Documentazione dell'API Java in formato PDF o ebook [chiusa]

Dato che ho un lungo viaggio in treno da e per il lavoro mi chiedevo se esiste una versione di Java Documentazione API che galleggia intorno a quella che potrei inserire sul mio Kindle. Sarebbe bello nella rara occasione in cui avessi qualcosa...
posta 10.02.2011 - 16:28
2
risposte

Specifica dell'autore nel codice sorgente in un prodotto commerciale

Di solito c'è un tag @author nella documentazione API (JavaDoc, PHPDoc, ecc.). È accettabile usare questo tag su ogni funzione che fai in un prodotto commerciale?     
posta 31.08.2012 - 07:25
1
risposta

Uno sviluppatore dovrebbe scrivere "documento soluzione" prima di iniziare la codifica?

Perché lo facciamo per "Pianificare prima di codificare" e un altro punto è "aiutare i nuovi arrivati nella squadra". Siamo una squadra di 5-8 membri. Disponiamo di documentazione API e Readme inclusi con i nostri progetti. Scrivere una soluzion...
posta 27.10.2018 - 12:24
1
risposta

Una webapp completamente funzionante senza architettura o documentazione completa su cosa fare

Abbiamo una webapp (webapp di e-commerce) su cui stiamo lavorando al momento. Per alcune funzioni abbiamo scritto diagrammi UML e diagrammi ERD. Abbiamo appena realizzato un'architettura di alto livello del sito web. Ma la domanda è, per sicurez...
posta 09.10.2018 - 19:40
1
risposta

Di cosa dovrei sapere, quando preparo un documento del sito Web per un successivo utilizzo di manutenzione? [chiuso]

Il team di sviluppo ha terminato un sito Web e il mio compito è preparare un documento in modo che altri programmatori possano mantenere il sito web con facilità. Non ho esperienza in questo e vorrei chiedere che cosa dovrebbe essere menziona...
posta 10.11.2012 - 04:06
1
risposta

Quale documentazione tecnica condividere e non condividere con un vasto pubblico?

Lavoro come sviluppatore di backend in un'organizzazione finanziaria e l'organizzazione ha richiesto la migrazione di tutta la nostra documentazione tecnica (ad esempio informazioni sui lotti come i nomi e la loro pianificazione e dipendenze, il...
posta 10.05.2018 - 09:10