Quali sono alcune risorse per imparare a scrivere specifiche?

Question

Al lavoro sono responsabile della stesura delle specifiche abbastanza spesso e sono anche la persona che ha insistito per ottenere le specifiche in primo luogo. Il problema è che non sono sicuro di come dovrebbero apparire le specifiche e cosa dovrebbero contenere. Molte volte quando il mio capo sta scrivendo le specifiche (ne siamo entrambi inesperti) inseriscono nomi di tabelle e cose che non credo appartengano a questo. Quindi qual è un buon modo per imparare a scrivere una buona specifica?

MODIFICA: una specifica funzionale dovrebbe includere elementi come supporre che io stia specificando un'applicazione Web, i tipi di input (una casella di testo, un elenco a discesa, ecc.)?

Answer 1

A mio avviso, la parte più importante della documentazione di sviluppo è fare in modo che la persona corretta lo faccia.

• Requisiti Documenti - Utenti + analista aziendale
• Specifiche funzionali - Analista aziendale + sviluppatore
• Specifiche tecniche (come verrà effettivamente implementata la funzionalità) - Sviluppatore senior / Architetto
• Stime di tempo ai fini della pianificazione: lo sviluppatore specifico assegnato all'attività

Avere qualcuno oltre allo sviluppatore / architetto senior che definisce le strutture / le interfacce delle tabelle ecc. è un esercizio di futilità, poiché lo sviluppatore più esperto generalmente ne elimina gran parte.

Wikipedia è in realtà un buon inizio per la specifica funzionale, che sembra simile alla tua specifica - http: / /en.wikipedia.org/wiki/Functional_specification .

Answer 2

C'è un grande capitolo nel Codice completo di Steve McConnell che scorre attraverso le specifiche documenti e cosa dovrebbero contenere.

Quando mi è stato affidato il compito di creare un team di Architettura e analisi aziendale presso un'azienda che non aveva mai avuto, ho usato il capitolo sulle specifiche di McConnell per creare lo schema per il documento delle Specifiche tecniche. Si è evoluto nel tempo, ma iniziando con questo framework ho fatto in modo di non perdere nulla e si è rivelato sorprendentemente utilizzabile.

Quando scrivo le specifiche, una regola empirica che seguo è quella di provare a far sì che i documenti tecnici inizino sempre dal generale e passino allo specifico - ribadire sempre i problemi aziendali o gli obiettivi che la soluzione tecnica è sviluppato per risolvere, quindi la persona che legge le specifiche non ha bisogno di andare ad altri documenti per metterlo in qualsiasi tipo di contesto.

Answer 3

Vedi Specifiche funzionali indolori di Joel Spolsky.

Alcune delle cose che dice che ogni specifica dovrebbe avere:

• Un disclaimer
• Un autore. Un autore
• Scenari
• Nongoals
• Una panoramica
• Dettagli, dettagli, dettagli
• Problemi aperti
• Note a margine

Answer 4

L'importante è scrivere qualcosa piuttosto che preoccuparsi del formato.

Answer 5

Compra libri: Ingegneria dei requisiti di Ian Sommerville & amp; Pete Sawyer ISBN 0-471-97444-7 o Requisiti software di Karl Wiegers ISBN 0-7356-0631-5