Domande con tag 'documentation'

domande con tag
3
risposte

Creazione della definizione dell'API pubblica per l'applicazione esistente

Diciamo che c'è un'applicazione di successo open source (scritta in PHP se è importante), che offre ai suoi utenti diversi modi per estenderla (pensa a qualcosa come Drupal o Wordpress, molti plugin personalizzati, ecc.). Ora diciamo che sfortun...
posta 22.09.2011 - 08:30
1
risposta

Qual è la differenza tra una pagina man e --help per uno script Python?

Attualmente sto sviluppando alcune procedure operative standard per la società per cui lavoro. Sto iniziando con gli esempi molto piccoli; come script. Attualmente ci sono diversi script scritti in diverse lingue. L'idea è di attenersi alle migl...
posta 02.10.2017 - 15:35
3
risposte

Documenting intent Vs knowledge

Si dice che dovresti documentare l'intento della tua funzione o classe con la quale sono d'accordo. Tuttavia recentemente questa linea è diventata un po 'sfocata quando volevo che qualcuno documentasse perché questa particolare classe è stata cr...
posta 19.03.2015 - 20:48
5
risposte

Qual è un termine generico per nome / identificatore? (Contrariamente all'etichetta)

Ho bisogno di fare riferimento a un certo numero di cose che hanno sia un valore identificativo (usato in codice e configurazione), sia un'etichetta leggibile dall'uomo. Queste cose includono: colonne del database elementi a discesa su...
posta 30.03.2012 - 11:34
1
risposta

SCRUM artefatti tecnici

La mia azienda sta introducendo SCRUM per lo sviluppo di nuovi software. Attualmente sono sia Product Owner che product manager responsabili degli aspetti tecnici del software. Il ruolo di manager tecnico non fa parte del team di scrum. Sto s...
posta 02.09.2011 - 00:52
5
risposte

È fattibile creare una mini documentazione all'interno del codice sorgente

Quindi, lavoro come sviluppatore. Siamo una piccola squadra. La maggior parte delle persone (tutti tranne il project manager e lo sviluppatore senior) sono ancora all'università. Abbiamo orari di lavoro molto flessibili, a volte non vedo alcune...
posta 24.06.2014 - 20:44
1
risposta

Come scrivere una documentazione adeguata per i riferimenti in un docblock? [chiuso]

Sto aggiungendo la documentazione al codice PHP usando lo strumento phpDocs: /** * This is a summary * * This is a description * * @use This function is called here and here */ function doSomething(){ } Mi sto solo chiedendo se voglio agg...
posta 11.06.2015 - 21:00
2
risposte

Chi dovrebbe scrivere la documentazione tecnica?

All'inizio pensavo che anche le persone che scrivevano il codice avrebbero dovuto documentarlo. Ma ci sono ragioni per le quali questo potrebbe non essere vero. Una persona che è nuova al codice potrebbe porre le domande giuste che potrebbero es...
posta 24.08.2016 - 16:41
3
risposte

Diagrammi UML per piccoli progetti

Tutto ad un tratto la necessità di una corretta documentazione formale è diventata una cosa nella nostra organizzazione. Un sacco di lavoro che faccio sono miglioramenti e aggiunte a un sistema esistente. Generalmente una soluzione rapida o un n...
posta 08.03.2013 - 04:15
2
risposte

Scrum agile - Importanza della raccolta dei requisiti e documentazione e suggerimenti per migliorare

Utilizziamo metodologie di scrum agile per lo sviluppo e la manutenzione di un prodotto. Dato che siamo una società di prodotti, non lavoriamo direttamente con il cliente giorno per giorno, ma comunichiamo con BA chi ci fornisce il requisito....
posta 01.05.2015 - 15:00