Spec Writing Management

9

Semplicemente non riesco ad immaginare di scrivere software senza una specifica. Non importa quanto sia abbozzato o di alto livello, le specifiche sono importanti per spiegare ai programmatori incapaci su quali sono le funzionalità del programma.

Ma il problema con le specifiche è che è in qualche modo un cittadino di seconda classe nell'intero ciclo di sviluppo del software; quando lo sviluppo prende il vapore, viene trascurato. Ma quando sorge una disputa, gli sviluppatori, i tester e le vendite si affannano per trovare le specifiche per giustificare i loro motivi.

Si verificheranno uno o più scenari:

  1. La specifica non può essere ripristinata, nessuno sa dove sia la specifica
  2. Diverse versioni delle specifiche emergono da diverse fonti; ci sono grandi difficoltà a scoprire quale versione è l'ultima versione, o se è disponibile una versione più recente.
  3. La specifica è incompleta, mancano alcune parti dei documenti a cui si riferisce.

Quindi la gestione delle specifiche è importante, ed è altrettanto importante che ognuno abbia solo una singola fonte di specifiche.

Come gestisci le tue specifiche? Ho provato a convincere tutti a utilizzare Google Docs ma tutti si sono opposti. Tutti sono semplicemente troppo affezionati e innamorati di Microsoft Word, che è, a loro avviso, molto facile da usare, molto facile da inserire nell'immagine, molto facile da digitare equazione e quant'altro.

Come convincerli che MS Word è semplicemente terribile per la condivisione?

    
posta Graviton 27.01.2011 - 16:20
fonte

5 risposte

6

How to convince them that MS Word is just terrible for sharing?

Non perdere tempo.

Per prima. Le specifiche dovrebbero essere in testo normale (veramente) e sotto il controllo del codice sorgente. Utilizza Markdown o RST o qualche altro strumento di marcatura leggero per produrre una pagina PDF o HTML. Testo normale.

Seconda. Prendi le varie fonti. Uniscili Scrivi il tuo documento finale.

Quando si oppongono, hanno due scelte.

  1. Utilizza Google Documenti (o lo strumento di controllo del codice sorgente) per modificare la tua versione .

  2. Continua a inviarti modifiche che modifichi, filtri e trasformi nel documento finale.

Preferisco # 2. Qualcuno ha bisogno di "possedere" le specifiche. E un sacco di gente (in stile wiki) porta a dibattiti e cambiamenti-guerre e documenti collaterali e conversazioni offline e simili.

    
risposta data 27.01.2011 - 16:28
fonte
6

Non penso che sia un problema di "strumento", ma piuttosto un problema di "processo" (o mancanza di processo).

Probabilmente hai già un processo per rilasciare software (unit test, test di integrazione, lettera di rilascio, consegna, ecc.), devi anche implementare un processo di documentazione.

  • Chi scriverà le specifiche? Chi li aggiornerà o li manterrà?
  • Chi esaminerà le specifiche?
  • Chi approverà le specifiche? Architetto, Capo progetto, QA?
  • Come vengono archiviate le specifiche?
  • Chi si assicurerà che non vengano utilizzate versioni obsolete?
risposta data 27.01.2011 - 16:29
fonte
4

È richiesto un certo tipo di controllo.

Deve essere versionato e firmato, e questo processo deve essere rigoroso.

In troppi luoghi, l'accesso è trascurato e questo porta a scontri.

La posizione non ha importanza fintanto che può essere monitorata

  • Sharepoint
  • un'unità di backup condivisa sicura
  • Ho visto alcuni posti usare il loro controllo del codice sorgente !!

Ma soprattutto è necessario acquistare da tutte le persone coinvolte e 1 o 2 persone che è responsabile di gestire sia il documento che la firma, ad es. il Project Manager.

    
risposta data 27.01.2011 - 16:26
fonte
0

MS Word è perfettamente adatto per creare una specifica. Gestiamo il nostro in SharePoint, che gestisce anche il controllo delle versioni. Se non hai a portata di mano SharePoint o un altro prodotto per la gestione dei documenti, Google Documenti è OK (ora puoi caricare file .doc / .docx senza convertirli nel formato di Google Documenti). O come altri hanno suggerito, puoi persino memorizzarli nel tuo sistema di controllo della versione del codice sorgente (se le persone che creano le specifiche hanno accesso a quel sistema).

    
risposta data 27.01.2011 - 18:47
fonte
0
 > How to convince them that MS Word is just terrible for sharing?

non puoi facilmente confrontare quale è la differenza tra due istanze in un sistema di controllo della versione.

Non mi piacciono le specifiche di parole per quel motivo. Ma dal momento che è una decisione politica usare le specifiche delle parole abbiamo come prima pagina "informazioni sulla storia" con queste colonne:

numero di versione (relativo alla verifica del prodotto), autore, data, descrizione

    
risposta data 09.05.2012 - 16:41
fonte

Leggi altre domande sui tag