Documentação em Engenharia de Requisitos

Introdução

A documentação é um aspecto fundamental da Engenharia de Requisitos, servindo como uma descrição formal dos requisitos de um sistema para clientes, usuários e a equipe de desenvolvimento. Inclui a especificação de requisitos, especificação funcional e caderno de encargos.

Como Documentar

A documentação geralmente utiliza linguagem natural, complementada com diagramas, tabelas e imagens. O grau de detalhe depende das práticas da organização e do propósito do documento. É importante seguir diretrizes, normas e boas práticas.

Propósito da Documentação

A documentação transmite as funcionalidades pretendidas para o sistema, especificando serviços, propriedades do sistema (como desempenho e confiabilidade) e restrições impostas ao desenvolvimento e operacionalidade do sistema.

Boas Práticas

Incluem formatar o documento para boa legibilidade, definir claramente os termos especializados, explicar como usar o documento, torná-lo fácil de alterar e descrever os principais cenários de utilização.

Padrões de Documentação

O padrão IEEE/ANSI 830-1998 é um exemplo, incluindo seções como introdução, descrição geral e requisitos específicos. Essa estrutura ajuda na organização e compreensão dos requisitos.

Métodos Formais

Existem métodos formais para especificar requisitos, como Z e VDM (Vienna Development Method). No entanto, esses métodos são considerados pesados e difíceis de aprender. A linguagem natural estruturada, complementada com diagramas, continua sendo a forma mais comum de documentação de requisitos.

Exemplos de Técnicas de Documentação

  • PLanguage: Especifica atributos de qualidade e usa um conjunto de palavras-chave.
  • RUP (Rational Unified Process): Inclui planos de gestão de requisitos, glossários, solicitações dos principais envolvidos e visão.

Metodologias Ágeis

Nas metodologias ágeis, o foco é na implementação efetiva de requisitos, não apenas na documentação. A documentação deve ser feita de maneira incremental e adaptável, utilizando ferramentas e documentos existentes.

UX em Metodologias Ágeis

  • Entregáveis de UX:
    • personas,
    • user journey maps:
      • Um “mapa de viagem” representa a perspetiva da experiência da pessoa, enquanto um mapa de “user stories” representa a perspetiva do produto e do que é necessário para proporcionar a experiência do utilizador
    • sitemaps,
    • fluxogramas,
    • wireframes,
    • protótipos e
    • Relatórios de Usabilidade