Domande con tag 'documentation'

domande con tag
3
risposte

Origine di "Leggimi"

Quando la gente ha iniziato a scrivere file Readme? Sembra che praticamente tutti i programmi abbiano questo file, indipendentemente dal formato. C'è qualche primo utilizzo documentato di questo documento?     
posta 29.07.2011 - 12:04
6
risposte

Formato foglio di calcolo Git-friendly? [chiuso]

Stiamo cercando di spostare la nostra documentazione di progetto da Google Documenti a una serie di repository Git self-hosted. I documenti di testo sono abbastanza amichevoli per Git, dato che di solito non abbiamo bisogno di alcuna formatta...
posta 04.01.2013 - 10:34
2
risposte

Qual è la differenza tra specifiche tecniche e documenti di progettazione?

Quali sono le specifiche tecniche? Sono uguali ai documenti di progettazione. In caso contrario, qual è la differenza e alcuni esempi?     
posta 15.12.2012 - 13:34
12
risposte

La documentazione in OOP dovrebbe evitare di specificare se un "getter" esegue o meno un calcolo?

Il programma CS della mia scuola evita qualsiasi menzione della programmazione orientata agli oggetti, quindi ho fatto alcune letture da solo per integrarlo, in particolare Costruzione di software orientata agli oggetti di Bertrand Meyer. M...
posta 26.08.2013 - 17:25
3
risposte

Quali roadblock affrontano il processo di sviluppo utilizzando linguaggi di markup in testo normale anziché, ad esempio, Microsoft Word? [chiuso]

Attualmente sono stagista presso un appaltatore governativo e ho l'impressione (odiosamente inevitabile) che Word sia lo standard de facto nel processo di sviluppo del software. Il suo formato binario rende molto difficile collaborare sui doc...
posta 17.07.2013 - 17:07
6
risposte

Spiegazione della sintassi nuova o non comune nei commenti [duplicato]

Come per il titolo, dovrei spiegare la sintassi che uso nel mio codice quando ho una ragionevole aspettativa che uno sviluppatore che guarda il mio codice in futuro non lo conosca? Breve avvertimenti o spiegazioni potrebbero essere aggiunti...
posta 26.08.2015 - 11:27
7
risposte

Prima rilascia o prima il documento?

Ho lavorato a un progetto per un paio d'anni e sto iniziando a raccogliere una base di utenti decente. Ho creato una pagina di progetto con una documentazione di base, ma a questo punto non è molto più di una FAQ. So che ho bisogno di migliorarl...
posta 14.06.2016 - 04:50
5
risposte

Come convincere la compagnia a iniziare la documentazione per il software legacy [duplicato]

È passato meno di un anno da quando sono entrato nella mia attuale compagnia. La maggior parte delle vendite proviene da un singolo prodotto che è rimasto in vita negli ultimi 10 anni. Tuttavia, c'è una documentazione minima (se non del tutto)...
posta 02.02.2012 - 14:35
8
risposte

Dovresti documentare tutto o solo la maggior parte?

Sembra un argomento controverso per documentare tutto, inclusa la sintassi "JavaBean" dei getter e setter per i campi: le persone dicono la sua rottura inutilmente lunga e ripetitiva ASCIUGA (non ripeterti) , che la convenzione di denominazion...
posta 10.10.2010 - 17:45
5
risposte

Progetta documenti come parte di Agile

Sul posto di lavoro, affrontiamo una sfida in quanto "agile" ha spesso significato "requisiti vaghi, cattivi criteri di accettazione, buona fortuna!" Stiamo cercando di risolverlo, come uno sforzo generale di miglioramento. Quindi, come parte...
posta 29.08.2012 - 13:33