Home > Engenharia de Software > Modelos/Exemplos
Modelo de Documento de Requisitos
1. INTRODUÇÃO
1.1 Finalidade
Identificar o produto cujo software requisitos são especificados neste documento, incluindo a revisão ou o número do lançamento.
1.2 Convenções de Documentos
Descrever quaisquer normas ou convenções tipográficas que foram seguidas ao escrever este documento, como fontes ou destacando que têm um significado especial. Por exemplo, indicar se as prioridades de requisitos de nível superior são assumidos para ser herdado por exigências detalhadas, ou se cada declaração requisito tem a sua própria prioridade.
1.3 Público-alvo e Sugestões de Leitura
Descrever os diferentes tipos de leitor que o documento se destina, tais como os desenvolvedores, gerentes de projetos, marketing pessoal, os usuários, testadores e escritores de documentação. Sugerir uma seqüência para a leitura do documento, começando com as seções de informações e prosseguindo até as seções que são mais pertinentes para cada tipo de leitor.
1.4 Escopo do Projeto
Fornecer uma breve descrição do software que está sendo especificado e seu propósito, incluindo benefícios relevantes, objetivos e metas. Relacionar o software aos objetivos empresariais e estratégias de negócios.
1.5 Referências
Lista de quaisquer outros documentos ou endereços da Web para que este se refere este documento. Estes podem incluir a relação do estilo guias de usuário, contratos, normas, especificações de requisitos do sistema, os documentos de casos de uso, ou um documento de visão e escopo. Forneça informações suficientes para que o leitor pode acessar uma cópia de cada referência, incluindo título, autor, número da versão, data e origem ou localização.
2. DESCRIÇÃO GERAL
2.1 Perspectiva do Produto
Descrever o contexto e origem do produto que está sendo especificado neste documento. Por exemplo, indicar se este produto é um membro de uma família de produtos, uma substituição para certos sistemas existentes, ou um novo produto. Se o documento define um componente de um sistema maior, identificar as interfaces entre os dois.
2.2 Características do Produto
Resumir os principais recursos que o produto contém ou funções importantes que deve realizar. Somente um resumo de alto nível é necessário neste item, detalhes serão fornecidos na Seção 3.
Organizar as funções para torná-las compreensíveis para qualquer leitor do documento.
Uma imagem dos principais grupos de requisitos relacionados e como eles se relacionam como um alto nível de diagrama de fluxo de dados ou um diagrama de classe, muitas vezes é eficaz.
2.3 Classes e Características dos Usuários
Identificar as classes de usuários previstos para o uso do produto.
As classes de usuário podem ser diferenciadas com base na freqüência de utilização, subconjunto de funções do produto usado, a perícia técnica, ou privilégio de níveis de segurança, nível de escolaridade, ou experiência.
Descrever as características pertinentes a cada classe de usuário.
Algumas exigências podem ser creditada apenas às classes determinado usuário.
Distinguir as classes favorecidas usuário daqueles que são menos importantes para satisfazer.
2.4 Ambiente Operacional
Descrever o ambiente no qual o software irá operar, plataforma, hardware, sistema operacional, versões, entre outros.
2.5 Dificuldades de Implementação
Descrever os itens ou questões que irão limitar as opções disponíveis para os desenvolvedores. Estes podem incluir: regulamentar políticas corporativas, limitações de hardware (requisitos temporais, os requisitos de memória), interfaces com outros aplicativos, tecnologias específicas, ferramentas e bases de dados, operações paralelas, exigências lingüísticas, protocolos de comunicação, aspectos de segurança, convenções de design ou padrões de programação, entre outros.
2.6 Documentação do Usuário
Lista de componentes da documentação do usuário (como manuais, ajuda-line sobre e tutoriais), que será entregue junto com o software.
Identificar qualquer utilizador conhecidas formatos de entrega de documentação ou normas.
2.7 Suposições e Dependências
Lista todos os fatores (em oposição a fatos conhecidos) que poderiam afetar os requisitos previstos. Estes poderiam incluir terceiros ou componentes comerciais que você pretende usar, as questões em torno do funcionamento ou ambiente de desenvolvimento, ou constrangimentos.
Identificar todas as dependências do projeto tem de fatores externos, tais como componentes de software que você pretende reutilizar a partir de outro projeto, a menos que eles já estejam documentados em outro lugar (por exemplo, no documento de visão e o alcance do plano ou projeto).
3. RECURSOS DO SISTEMA
Organizar os requisitos funcionais do produto pelas características do sistema, principais serviços prestados pelo produto, caso de uso, modo de funcionamento, classe de usuário, objeto funcional, hierarquia de classes, ou combinações destes.
3.1 Feature 1 <identificação de acordo com a organização selecionada>
3.1.1 Descrição e Prioridade
Fornecer uma breve descrição da funcionalidade e indicar se a prioridade é de alta, média ou baixa.Você pode também incluir avaliações específicas, tais como: benefício, penalidade, custo e risco (cada um avaliado em uma escala relativa de uma baixa de 1 a um máximo de 9).
3.1.2 Estímulo Resposta Sequências
Listar as seqüências de ações do usuário e as respostas do sistema que estimulam o comportamento definido para este recurso. Estes correspondem aos elementos de diálogo associadas com casos de uso.
3.1.3 Requisitos Funcionais
Listar os requisitos funcionais detalhados associado com esse recurso. Estes são os recursos de software que devem estar presentes para que o usuário realize os serviços prestados pelo recurso, ou para executar o caso de uso.
Incluir como o produto deve responder às condições de erro antecipadas ou entradas inválidas.
3.2 Feature 2 <identificação de acordo com a organização selecionada>
3.2.1 Descrição e Prioridade …
4. REQUISITOS DE INTERFACE EXTERNA
4.1 Interfaces de Usuário
Descrever as características lógicas de cada interface entre o software e os usuários. Isso pode incluir a imagem das telas, layout, restrições de tela, botões e funções padrão (por exemplo, ajuda) que irá aparecer em cada tela, atalhos de teclado, a mensagem de erro padrões de exibição, e assim por diante.
4.2 Hardware / Interfaces
Descrever as características físicas e lógicas de cada interface entre o software e os componentes de hardware do sistema.
4.3 Software / Interfaces
Descrever as ligações entre este produto e outros componentes de software específico (nome e versão), incluindo bases de dados, sistemas operacionais, ferramentas, bibliotecas e componentes integrados comerciais.
Identificar os itens de dados ou mensagens que chegam e saem do sistema, bem como a finalidade de cada um.
Descrever os serviços necessários e à natureza das comunicações.
Identificar os dados que serão compartilhados entre os componentes de software.
4.4 Interfaces de Comunicação
Descrever os requisitos associados com as funções de comunicações exigidas por este produto, incluindo e-mail, navegador web, protocolos de rede do servidor de comunicações, formulários eletrônicos, e assim por diante.
Especificar qualquer método de segurança ou criptografia, problemas de comunicação, as taxas de transferência de dados, mecanismos de sincronização, entre outros.
5. REQUISITOS NÃO FUNCIONAIS
5.1 Requisitos de Desempenho
Se houver requisitos de desempenho(+) para o produto em várias circunstâncias, o estado deles deve ser explicado nesta seção, para ajudar os desenvolvedores a entender a intenção e fazer escolhas de design adequado. Por exemplo, você pode precisar de requisitos de desempenho(+) para cada estado funcional ou recursos.
5.2 Requisitos de Segurança
Especificar os requisitos que estão preocupados com a possível perda, danos ou prejuízos que poderiam resultar da utilização do produto. Defina quaisquer garantias ou ações que devem ser tomadas, bem como ações que devem ser evitadas (políticas externas ou regulamentos da organização).
5.3 Requisitos de Segurança
Especificar os requisitos em matéria de segurança ou privacidade, questões que envolvem a utilização do produto ou a proteção dos dados utilizados ou criados pelo produto.
Definir requisitos de autenticação do usuário no sistema.
5.4 Atributos de Qualidade de Software
Especificar quaisquer características de qualidade adicionais para o produto que será importante para ambos os clientes (internos e externos). Algumas características consideradas: adaptabilidade, disponibilidade, exatidão, flexibilidade, interoperabilidade, durabilidade, portabilidade, confiabilidade, reusabilidade, robustez e usabilidade.