Quais são alguns recursos para aprender com as especificações de escrita?

Question

No trabalho eu sou responsável por escrever as especificações muitas vezes e eu também sou a pessoa que insistiu em obter especificações em primeiro lugar. O problema é que eu sou inseguro como especificações deve olhar eo que devem conter. Uma grande parte do tempo, quando o meu patrão está escrevendo as especificações (ambos somos inexperientes em que) eles colocaram em nomes de tabelas e as coisas que eu não acho que pertencem lá. Então, o que é uma boa maneira de aprender a escrever uma boa especificação?

EDIT:? Se um especificação funcional incluem coisas como supondo que eu estou especificando uma aplicação web, os tipos de entrada (uma caixa de texto, lista suspensa, etc)

Answer 1

A parte mais importante de documentação de desenvolvimento, na minha opinião, é ter a pessoa certa fazê-lo.

• Requisitos Docs - Usuários + Business Analyst
• Funcional Spec - Analista de Negócios + desenvolvedor
• Spec Técnica (como a funcionalidade será realmente implementado) - Sr. Developer / Arquiteto
• Tempo estimativas para fins de agendamento - O desenvolvedor específico atribuído à tarefa

Tendo ninguém além do Sr. Developer / Architect definir estruturas de tabelas / interfaces etc. é um exercício de futilidade -. Como o desenvolvedor mais experiente geralmente jogar a maior parte fora

Wikipedia é realmente um bom começo para a especificação funcional, o que parece semelhante ao seu Spec - http: / /en.wikipedia.org/wiki/Functional_specification .

Answer 2

Há um grande capítulo na Code Complete de Steve McConnell que atravessa especificação documentos eo que devem conter.

Quando eu tinha a tarefa de construir uma equipe de Arquitetura e Análise de Negócios em uma empresa que nunca tinha tido tanto, eu usei capítulo especificação de McConnell para criar o esquema do documento de Especificação Técnica. Ela evoluiu ao longo do tempo, mas começando com este quadro tenho a certeza que não perca nada e ele acabou por ser surpreendentemente utilizável.

Ao escrever especificações, uma regra de ouro que eu sigo é tentar ter documentos técnicos começam sempre do geral e ir para o específico - sempre reafirmar o problema de negócio (s) ou objetivo (s) que a solução técnica é sendo desenvolvido para resolver, de modo que a pessoa que lê a especificação não precisa ir a outros documentos para colocá-lo em qualquer tipo de contexto.

Answer 3

Consulte Painless Funcional Specs por Joel Spolsky.

Algumas das coisas que ele diz que cada especificação deve ter:

• Um aviso
• Um autor. Um autor
• Cenários
• Nongoals
• Uma Visão Geral
• Detalhes, detalhes, detalhes
• Questões em aberto
• notas laterais

Answer 4

O importante é obter algo escrito para baixo, em vez de se preocupar com o formato.

Answer 5

Comprar Livros: Engenharia de Requisitos por Ian Sommerville & Pete Sawyer ISBN 0-471-97444-7 ou Requisitos de Software por Karl Wiegers ISBN 0-7356-0631-5