Instituto de Cincias Matemticas de So Carlos Universidade de So Paulo So Carlos

ESPECIFICAO DE REQUISITOS: UMA INTRODUO

Marcelo Augusto Santos Turine1 Paulo Cesar Masiero

E-mail: {mast/masiero}@icmsc.sc.usp.br

Maro de 1996

Este trabalho foi desenvolvido como parte das atividades do estgio supervisionado realizado no Programa de Aperfeioamento de Ensino (PAE) no segundo semestre de 1995.
1

CONTEDO

1. INTRODUO................................................................................................. 3 2. UMA VISO GERAL DA ENGENHARIA DE REQUISITOS..................... 2.1. Elicitao de Requisitos........................................................................ 2.2. Anlise de Requisitos............................................................................ 2.3. Modelagem............................................................................................ 2.4. Documento de Requisitos do Software................................................. 3. AVALIAO DE UM DOCUMENTO TEXTUAL DE REQUISITOS........ 3.1. Especificao Informal.......................................................................... 3 4 6 6 6 10 10 12

3.2. Anlise Crtica....................................................................................... 4. PROPOSTA DE UM DOCUMENTO TEXTUAL DE REQUISITOS DO USURIO.........................................................................................................

14

5. CONCLUSES................................................................................................. 18

APNDICE I: VOCABULRIO RELATIVO AO SAPES................................ 20 APNDICE II: DIAGRAMA DO DOMNIO..................................................... 25 REFERNCIA BIBLIOGRFICA..................................................................... 26

1. Introduo
O processo de desenvolvimento de software compreende um conjunto de atividades que engloba mtodos, ferramentas e procedimentos, com o objetivo de produzir softwares que atendem aos requisitos especificados pelos usurios (clientes) [May90; Pre94]. A satisfao dos requisitos especificados pelos usurios a prcondio bsica para o sucesso de um software. Um software que foi mal especificado, certamente ir desapontar o usurio e causar problemas equipe de desenvolvimento, que ter de modific-lo para se adequar s necessidades do usurio. De acordo com Castro [Cas95], a especificao de requisitos serve como um padro para testar se as fases de projeto e implementao do processo de desenvolvimento de software esto corretas. O objetivo principal deste trabalho mostrar como um documento de requisitos (informal) deve ser organizado e redigido para que seja legvel, no ambguo e siga as diretrizes propostas por padres internacionais (por exemplo, Norma ISO/IEC 9126) quanto especificao de requisitos. Isso realizado apresentando-se uma verso de um documento de requisitos que analisada e corrigida, dando origem a um documento organizado dentro dos padres propostos. Este trabalho apresenta na seo 2 uma viso geral da engenharia de requisitos, dando nfase, principalmente, definio e ao processo de engenharia de requisitos. Na seo 3 apresentado um exemplo de um documento de requisitos (especificao informal) de um determinado problema. A partir de uma anlise crtica dessa especificao, utilizando regras de estruturao de especificaes de requisitos, apresentado na seo 4 um documento estruturado de requisitos do sistema. Finalizando, a seo 5 contm as concluses deste trabalho.

2. Uma Viso Geral da Engenharia de Requisitos

Inicialmente, necessrio distinguir os termos requisito e especificao. Uma maneira de clarear este distino utilizar a definio do glossrio de engenharia de software [IEE90] e do dicionrio Aurlio [Aur86].

O glossrio de engenharia de software do IEEE [IEE90] define requisito como: 1. Uma condio ou capacidade necessitada por um usurio para resolver um problema ou alcanar um objetivo. 2. Uma condio ou capacidade que deve ser satisfeita ou possuda por um sistema ou componente do sistema para satisfazer um contrato, um padro ou uma especificao.

3. Uma representao documentada de uma condio ou capacidade como em (1) ou (2). Segundo o dicionrio Aurlio [Aur86], o termo requisito pode ser definido como condio necessria para a obteno de certo objetivo, ou para o preenchimento de certo fim. J o termo especificao uma descrio rigorosa e minuciosa das caractersticas que um material, uma obra, ou um servio devero apresentar. De acordo com o IEEE [IEE84; IEE91], o processo de aquisio, refinamento e verificao das necessidades do usurio chamado de engenharia de requisitos (E.R.). O objetivo da E.R. sistematizar o processo de definio dos requisitos, obtendo uma especificao correta e completa dos requisitos. O entendimento da engenharia de software como uma disciplina que procura tornar mais eficaz o software e mais eficiente o processo utilizado para produzir este software fundamental para entender o papel da E.R. Boehm [Boe89] define a E.R. como uma disciplina cujo objetivo desenvolver uma especificao completa, consistente e no ambgua, servindo de base para um acordo entre todas as partes envolvidas e descrevendo o qu o produto de software ir fazer ou executar, mas no como ele ser feito. Segundo Leite [Lei90; Lei94], a E.R. estabelece o processo de definio de requisitos como um processo no qual o que deve ser feito elicitado, modelado e analisado. Este processo deve se basear em diferentes pontos de vista e usar uma combinao de mtodos, ferramentas e pessoal. O produto deste processo um modelo que servir para produzir um documento de requisitos. Este processo acontece num contexto chamado de Universo de Informaes (UdeI), que apresentado na Figura 1 e descrito a seguir. Para produzir um documento de requisitos completo e consistente produto da E.R. necessrio, inicialmente, entender melhor o contexto em que o problema se situa, ou seja, quais so os objetivos do produto a ser desenvolvido, as tarefas/atividades fundamentais para a engenharia deste produto e os limites do desenvolvimento. Assim, para especificar corretamente os requisitos necessrio definir o UdeI. Segundo Leite [Lei94], UdeI o contexto geral no qual o software dever ser desenvolvido. O UdeI inclui todas as fontes de informao e todas as pessoas relacionadas ao software, s quais denominamos de agentes deste universo. O UdeI a realidade circunstanciada pelo conjunto de objetivos definidos por quem solicitou o software. 2.1. Elicitao de Requisitos

A palavra elicitao no existe na lngua portuguesa, mas foi criada e tem sido utilizada por vrios autores (e.g., Leite em [Lei94]) englobando o significado dos verbos eliciar (fazer sair, extrair, trazer tona a verdade), clarear, extrair e descobrir. Assim, uma definio sucinta de elicitao obter e tornar explcito o mximo de informaes possveis para o conhecimento de um objeto em questo.
UdeI

ELICITAR

Documento de Requisitos do Sistema

UdeI

ANALISAR Decises da Anlise MODELAR Mtodos, Tcnicas e Ferramentas

Modelo de Anlise do Sistema Figura 1: Processo de Engenharia de Requisitos.

Na fase de elicitao de requisitos o engenheiro de requisitos procura captar os requisitos do software, buscando obter conhecimento do domnio do problema. Para alcanar tal objetivo, esta fase utiliza trs atividades principais: identificao das fontes de informao, coleta de fatos e comunicao, alm de ferramentas, pessoal e mtodos. Para identificar as fontes de informao o engenheiro de requisitos utiliza o UdeI, que contm toda a informao do domnio do problema, compreendendo os agentes (autores, usurios) mais outras fontes de informao, como por exemplo:

documentao do macrosistema, polticas da organizao (por exemplo, Plano Diretor de Informtica), manuais de equipamentos de hardware e software, memorandos, atas de reunio, contratos com fornecedores, livros sobre tema relacionado, outros sistemas da empresa e outros sistemas externos. Na atividade de coleta de fatos, usualmente so feitas entrevistas com os clientes, so consultados os materiais existentes que descrevem os objetivos e desejos da

organizao, e tambm pesquisada a existncia de sistemas similares para uma posterior anlise. importante observar que o uso apenas de entrevista no suficiente para obter todas as informaes necessrias. Outras tcnicas importantes para a coleta de fatos sobre um sistema so: leitura de documentos, observao, questionrios, anlise de protocolos, participao ativa dos agentes (autor e usurio) do UdeI, enfoque

antropolgico, reunies, reutilizao e recuperao (engenharia reversa) do projeto do software. Para que a elicitao tenha sucesso fundamental que os engenheiros de requisitos se comuniquem eficazmente com os clientes ou pessoas (especialistas) que entendem o problema. O engenheiro de requisitos precisa se envolver com o trabalho do cliente e/ou especialistas no domnio, se envolver com os funcionrios, observar, aprender e questionar. Como resultado da fase de elicitao de requisitos desenvolvido o documento de requisitos do sistema que contm a especificao de requisitos. Este documento utilizado como base para as fases seguintes: anlise de requisitos e modelagem [Fio95]. 2.2. Anlise de Requisitos A fase de anlise de requisitos fundamental para o sucesso do processo de desenvolvimento do software. Nesta fase, o projetista (engenheiro de requisitos) especifica as funes e desempenho do software, indica a interface do software com outros sistemas, estabelece as restries de projeto do software [Pre94]. O objetivo da fase de anlise de requisitos avaliar e revisar o escopo do software (documento de requisitos do software). Atravs de um processo de descoberta, refinamento, modelagem e especificao, o objetivo obter uma especificao de requisitos completa e consistente. Pelas razes expostas acima, muito provvel que o documento de requisitos obtido at ento, possua vrias inconsistncias ou problemas de funcionalidade, e o projetista durante esta fase deve ser capaz de detectar e resolver inconsistncias. As decises de anlise servem para realimemtar e melhorar o documento de requisitos do sistema, pois este ser a base para todas as fases da engenharia de software subseqentes. 2.3. Modelagem A fase de modelagem tem por objetivo criar e desenvolver modelos que

descrevem esttica e dinamicamente o que o sistema deve fazer, e no como deve ser feito. Estes modelos expressam os requisitos descritos no documento de requisitos, possibilitando um maior entendimento do domnio da aplicao, servindo para determinar se a especificao est completa, consistente e precisa, fornecendo uma transio para a fase de projeto. Diversos mtodos para apoiar o projetista na modelagem de sistemas existem na literatura, como por exemplo: FUSION [Col94], Booch [Boo91], OMT, JSD e Anlise Estruturada. 2.4. Documento de Requisitos do Software

O documento de requisitos de um software contm todos os requisitos funcionais e de qualidade do software, incluindo as capacidades do produto, os recursos disponveis, os benefcios e os critrios de aceitao. Este documento serve como um meio de comunicao entre o projetista do software e o usurio, a fim de estabelecer um acordo acerca do software pretendido. Deve-se evitar que durante o desenvolvimento do documento de requisitos decises de projeto sejam tomadas. Assim, devido importncia do documento de requisitos dentro do processo de desenvolvimento do software, fundamental que este documento seja organizado de forma a melhorar a compreenso e a legibilidade dos requisitos, evitando que problemas e erros surjam na fase de implementao do software. O documento de requisitos do sistema deve ser composto por sentenas em linguagem natural, seguindo determinados padres: 1) Iniciar com O sistema deve .... Exemplo: O sistema deve rodar em microcomputadores da linha IBM PC que possuam microprocessador 486 DX ou superior. 2) Os requisitos devem estar organizados logicamente, como por exemplo, inicialmente todos os requisitos de entrada, depois os de processamento e por ltimo os requisitos de sada. 3) Cada requisito deve ter um identificador nico, por exemplo, um identificador numrico, para posterior referncia. 4) Os requisitos do software devem estar divididos em requisitos funcionais e no funcionais. Embora as suas fronteiras nem sempre sejam precisas de se determinar, esta diviso tem sido bastante usada na literatura. A Norma ISO/IEC 9126 [ISO9126] define seis caractersticas de qualidade de software que devem ser avaliadas e tambm prope algumas subcaractersticas: Funcionalidade, Usabilidade, Confiabilidade, Eficincia, Manutenibilidade e Portabilidade. A seguir cada um destas caractersticas ser descrita segundo esta norma. A Funcionalidade define os requisitos funcionais que o software ou componentes do software devem executar. A funcionalidade diz respeito finalidade a que se prope

o produto de software e , portanto, a principal caracterstica de qualidade para qualquer tipo de software. Definio de Funcionalidade [ISO9126]: Conjunto de atributos que evidenciam a existncia de um conjunto de funes e suas propriedades especificadas. As funes

so as que satisfazem as necessidades explcitas e implcitas2. A Norma ISO/IEC 9126 apresenta ainda, de forma informativa, a subdiviso em subcaractersticas: 4.1. Adequao: atributos do software que evidenciam a presena de um conjunto de funes e sua apropriao para as tarefas especificadas. 4.2. Acurcia: atributos do software que evidenciam a gerao de resultados ou efeitos corretos ou conforme acordados. 4.3. Interoperabilidade: atributos do software que evidenciam sua capacidade de interagir com sistemas especificados. 4.4. Conformidade: atributos do software que fazem com que ele esteja de acordo com as normas, convenes ou regulamentaes previstas em leis e descries similares, relacionadas aplicao. 4.5. Segurana de acesso: atributos do software que evidenciam sua capacidade de evitar o acesso no autorizado, acidental ou deliberado, a programas e dados. Os requisitos no funcionais, tambm denominados de requisitos de qualidade, incluem tanto limitaes no produto (desempenho, confiabilidade e segurana) como limitaes no processo de desenvolvimento (custos, mtodos a serem adotados no desenvolvimento e componentes a serem reutilizados). As caractersticas de qualidade de software so: Usabilidade, Confiabilidade, Eficincia, Manutenibilidade e Portabilidade. Definio de Usabilidade [ISO9126]: Conjunto de atributos que evidenciam o esforo necessrio para se poder utilizar o software, bem como o julgamento individual desse uso, por um conjunto explcito ou implcito de usurios3. A Usabilidade caracterizada por um produto ser fcil de usar, de aprender e de recordar. A satisfao do usurio quando usa um produto um fator importante. E, mais importante ainda, verificar se o produto desempenha eficientemente a tarefa para a qual foi projetado. Usabilidade tem se tornado uma vantagem competitiva e significativa no desenvolvimento de software. A Norma ISO/IEC 9126 apresenta a subdiviso em subcaractersticas de usabilidade: 4.6. Inteligibilidade: atributos do software que evidenciam o esforo do usurio para reconhecer o conceito lgico e sua aplicabilidade. 4.7. Apreensibilidade: atributos do software que evidenciam o esforo do usurio para aprender sua aplicao (por exemplo: controle de operao, entradas, sadas). 4.8. Operacionalidade: atributos do software que evidenciam o esforo do usurio para sua operao e controle da sua operao.
2

Esse conjunto de atributos caracteriza o que o software faz para satisfazer as necessidades, enquanto os outros conjuntos caracterizam principalmente quando e como ele faz. 3 A usabilidade deve levar em conta os vrios ambientes de usurios que o software pode afetar, que podem abranger desde a preparao para uso at a avaliao de resultados. A usabilidade definida nesta Norma diferente da definio do ponto de vista ergonmico, em que outras caractersticas como eficincia e eficcia tambm so consideradas componentes da usabilidade. 8

Definio de Confiabilidade [ISO9126]: Conjunto de atributos que evidenciam a capacidade do software de manter seu nvel de desempenho sob condies estabelecidas durante um perodo de tempo estabelecido4. As subcaractersticas de confiabilidade so: 4.9. Maturidade: atributos do software que evidenciam a freqncia de falhas por defeitos no software. 4.10. Tolerncia a Falhas: atributos do software que evidenciam sua capacidade em manter um nvel de desempenho especificado nos casos de falhas no software ou de violao nas interfaces especificadas. 4.11. Recuperabilidade: atributos do software que evidenciam sua capacidade de restabelecer seu nvel de desempenho e recuperar os dados diretamente afetados, em caso de falha, e em tempo e esforo necessrios para tal. Definio de Eficincia [ISO9126]: Conjunto de atributos que evidenciam o relacionamento entre o nvel de desempenho do software e a quantidade de recursos usados, sob condies estabelecidas5. A subdiviso das caractersticas de eficincia : 4.12. Comportamento em relao ao Tempo: atributos do software que evidenciam seu tempo de resposta, tempo de processamento e velocidade na execuo de suas funes. 4.13. Comportamento em relao aos Recursos: atributos do software que evidenciam a quantidade de recursos usados e a durao de seu uso na execuo de suas funes. Definio de Manutenibilidade [ISO9126]: Conjunto de atributos que evidenciam o esforo necessrio para fazer modificaes especificadas no software6. A Manutenibilidade a facilidade com a qual o programa pode ser corrigido se um erro encontrado; ser adaptado se o ambiente mudar ou ser melhorado se o cliente desejar alguma mudana nos requisitos. Provavelmente, o fator mais importante que afeta a manutenibilidade o planejamento para manutenibilidade. Se o software visto como um elemento de um sistema que inevitavelmente sofrer mudanas, as chances de se produzir um software manutenvel iro aumentar substancialmente. A subdiviso das subcaractersticas de manutenibilidade : 4.14. Analisabilidade: atributos do software que evidenciam o esforo necessrio

para diagnosticar deficincias ou causas de falhas ou para identificar partes a serem modificadas.
Em software no ocorre desgaste ou envelhecimento. As limitaes em confiabilidade so decorrentes de defeitos na especificao dos requisitos, projeto ou implementao. As falhas decorrentes desses defeitos dependem de como o produto de software usado e das opes de programa selecionadas, e no do tempo decorrido. 5 Os recursos podem incluir outros produtos de software, hardware, materiais (por exemplo: papel para impressora, discos flexveis) e servios de operao, manuteno ou suporte. 6 As modificaes podem incluir correes, melhorias ou adaptaes do software devido a mudanas no ambiente, ou nos seus requisitos.
4

4.15. Modificabilidade: atributos do software que evidenciam necessrio para modific-lo, remover seus defeitos ou adapt-lo a ambientais. 4.16. Estabilidade: atributos do software que evidenciam o risco inesperados ocasionados por modificaes. 4.17. Testabilidade: atributos do software que evidenciam o esforo para validar o software modificado.

o esforo mudanas de efeitos necessrio

Definio de Portabilidade [ISO9126]: Conjunto de atributos que evidenciam a capacidade do software de ser transferido de um ambiente para outro7. As subcaractersticas de portabilidade so: 4.18. Adaptabilidade: atributos do software que evidenciam sua capacidade de ser adaptado a ambientes diferentes especificados, sem a necessidade de aplicao de outras aes ou meios alm daqueles fornecidos para essa finalidade pelo software considerado. 4.19. Capacidade para ser instalado: atributos do software que evidenciam o esforo necessrio para sua instalao num ambiente especificado. 4.20. Capacidade para substituir: atributos do software que evidenciam sua capacidade e esforo necessrio para substituir um outro software, no ambiente estabelecido para esse outro software. 4.21. Conformidade: atributos do software que o tornam consonante com padres ou convenes relacionados portabilidade.

3. Avaliao de um Documento Textual de Requisitos

3.1. Especificao Informal A seguir apresentado o documento de requisitos do Sistema de Apoio Escrita (SAPES). Este documento resultado da fase de elicitao de requisitos do processo de engenharia de requisitos e foi especificado por um pesquisador, preocupado em desenvolver um sistema para apoiar o seu trabalho de pesquisa e redao de artigos cientficos. Deseja-se construir um sistema de auxlio pesquisa bibliogrfica. Esse sistema deve possuir um arquivo de itens bibliogrficos (arquivo de bibliografia) contendo informaes tais como: nome, local e data da publicao; autor; resumo; etc. Esse arquivo pode ser atualizado, consultado e utilizado de diversas maneiras. Um tipo de utilizao que o sistema deve permitir a de produzir, de forma automatizada, um
7

O ambiente pode incluir ambiente organizacional, de hardware ou de software.

10

arquivo de referncias bibliogrficas relativo a um documento especfico em elaborao. Ou seja, tendo como base o texto do documento, identificar todas as referncias que ocorrem no texto, extrair da base bibliogrfica e armazenar, em forma padro, em arquivo, que ser posteriormente parte integrante do documento em elaborao. A seguir relata-se como essas atualizaes, consultas e utilizaes devem ser efetuadas.

1) Informaes para a atualizao do arquivo de bibliografia - Um item bibliogrfico pode ser adicionado ao arquivo, desde que ele j no exista no arquivo. - Os itens de informao associados insero de bibliografia podem ser referenciados por sinnimos, essencialmente autores, editoras, peridicos e congressos. - Mensagens de erro devem ser fornecidas quando itens bibliogrficos incompletos forem inseridos; esses itens devem ser, mesmo assim, armazenados no arquivo de bibliografia. - A incluso de um item bibliogrfico j existente deve ser considerada como uma possvel alterao. - A forma de referncia deve ser elaborada automaticamente utilizando o padro ABNT: as trs primeiras letras do sobrenome do primeiro autor seguido do ano de publicao. No caso de duas ou mais publicaes do mesmo primeiro autor no mesmo ano, distinguem-se essas publicaes utilizando-se as letras a para a primeira publicao, b para a segunda, e assim por diante. - A numerao lgica das bibliografias deve ter uma correspondncia com a numerao e localizao fsica das bibliografias. - Um item bibliogrfico pode ser excludo do arquivo de bibliografia desde que ele j exista. - Um item bibliogrfico existente pode ser editado e qualquer informao relativa quele item pode ser alterado. - A consistncia da numerao lgica e fsica no se altera.

- Deve ser possvel importar o arquivo de bibliografia de outros pesquisadores, com diferentes alternativas e com ou sem confirmao; as alternativas devem ser semelhantes s alternativas de busca no arquivo de bibliografia. - O sistema deve fornecer facilidades para a realizao de backups das bibliografias. 2) Informaes para a consulta ao arquivo de bibliografia

11

- Um item bibliogrfico deve poder ser identificado por qualquer combinao de um ou mais autores (sobrenome), ano, assunto, perodo, etc. - Deve ser possvel, no momento da busca, se optar pela impresso dos itens bibliogrficos ou pela cpia dos itens no arquivo, de forma total ou parcial. - O sistema deve fornecer ao usurio as informaes contidas na base relativas s alternativas de busca selecionadas pelo mesmo.

3) Informaes para a emisso de relatrios - Dever ser possvel a solicitao de relatrios, com alternativas de seleo semelhantes s alternativas de seleo da consulta e identificao de bibliografia, com possibilidade de confirmao dos itens a serem impressos. - Deve-se fornecer facilidades para a criao e impresso de fichas tcnicas, com informaes essenciais e objetivas relativas a um conjunto de itens bibliogrficos. As fichas tcnicas criadas devem ser armazenadas e eliminadas sob a solicitao do usurio. - Deve-se fornecer facilidades para a obteno de relatrios ordenados por diferentes alternativas: ano. autor, ttulo, etc. 4) Informaes quanto gerao das referncias de um texto - A partir de um arquivo texto, o sistema deve gerar automaticamente um arquivo de referncias contendo os itens bibliogrficos citados no texto. - O arquivo de referncias deve ser um arquivo padro, de forma a possibilitar a juno com o arquivo texto. Seria conveniente se existissem alternativas para os editores mais comumente utilizados. - A forma de identificao dos itens bibliogrficos mencionados no texto deve sempre estar na forma [ABCnn], onde ABC representa as trs primeiras letras do

sobrenome do primeiro autor e nn o ano de publicao. O sistema deve fornecer facilidades para adequar tanto o texto como o arquivo de referncias forma de citao requerida pela entidade qual o trabalho ser submetido. - O sistema deve emitir uma mensagem se existir alguma citao no trabalho e essa no estiver na bibliografia. - Ao usurio ser permitido somente completar algum item do arquivo de referncias; ou aqueles inexistentes na bibliografia, ou aqueles que eventualmente tenham sido inseridos de forma incompleta. No deve ser possvel ao usurio alterar as informaes geradas automaticamente pelo sistema.

12

5) Informaes quanto interface - A interface deve ser grfica, de acordo com um padro de interface, dirigida a menu. - Alternativamente, o sistema deve possibilitar o seu uso atravs de linhas de comandos, para usurios avanados. - Aspectos de portabilidade devem ser considerados no projeto da interface e no projeto e implementao do prprio sistema.

3.2. Anlise Crtica Este documento de requisitos possui vrios problemas, de acordo com as diretrizes apresentadas na seo anterior: 1- A especificao informal procura seguir a regra de frases curtas, usando frases do tipo O Sistema deve ..., entretanto, isto no feito de forma padronizada. Exemplo: Um item bibliogrfico pode ser adicionado ao arquivo, desde que ele j no exista no arquivo. 2- Cada seo da especificao informal descreve vrios requisitos ao invs de um nico requisito. Assim, apesar de cada seo da especificao informal ser numerada, no obedece a uma forma de organizao do item 3 (seo 2.4), que exige que cada requisito deve ter um identificador nico. 3- Apesar das sees que contm os requisitos estarem organizadas logicamente Informaes para a atualizao do arquivo de bibliografia, Informaes para a consulta ao arquivo de bibliografia, Informaes para a emisso de relatrios, Informaes quanto gerao das referncias de um texto e Informaes quanto interface os requisitos no esto organizados corretamente de acordo com os cenrios ou casos de uso (use-cases) do pesquisador (Violou o item 2 da seo 2.4.). Por exemplo, o requisito O sistema deve fornecer facilidades para a realizao de backups das bibliografias no est classificado corretamente dentro da seo Informaes para a atualizao do arquivo de bibliografia.

4- Os requisitos no esto separados em funcionais e de qualidade. Violou o item 4 da seo 2.4.

13

5- O texto se refere a detalhes de implementao, o que no conveniente nesta fase de desenvolvimento. importante no utilizar termos relacionados implementao como arquivo e menu. Exemplo: A interface deve ser grfica, de acordo com um padro de interface, dirigida a menu. 6- H requisitos muito vagos, que do apenas uma idia das preocupaes do usurio, mas no podero ser validados objetivamente ao final do desenvolvimento. Exemplos: a) A consistncia da numerao lgica e fsica no se altera. b) Aspectos de portabilidade devem ser considerados no projeto da interface e no projeto e implementao do prprio sistema.

7- Os requisitos esto misturados com as definies de termos do domnio da aplicao. Exemplo: No necessrio explicar na descrio do requisito como o padro ABNT (quinto requisito da seo 1). 8- Alguns requisitos so inconsistentes. Exemplos: a) No quinto requisito da seo 1 (Informaes para a atualizao do arquivo de bibliografia) o que deve ser feito se dois autores distintos tiverem o mesmo sobrenome? b) O terceiro requisito da seo 4 (Informaes quanto gerao das referncias de um texto) no se refere aos sufixos a, b, c, etc. trazendo dvidas em relao ao quinto requisito da seo 1 (Informaes para a atualizao do arquivo de bibliografia). 9- No h consistncia no uso dos termos do domnio. Exemplos:

a) A palavra arquivo do primeiro requisito da seo 1 (Informaes para a atualizao do arquivo de bibliografia) a mesma que a expresso arquivo de bibliografia do terceiro e sexto requisito da seo 1, e tambm a mesma que

bibliografia do quarto requisito da seo 4? b) O termo ... citados no texto do primeiro requisito da seo 4 o mesmo que ... mencionados no texto. do terceiro requisito da seo 4, e tambm o

14

mesmo que ... se existir alguma citao no trabalho.... do quarto requisito da seo 4? 10- Existem requisitos que no tem sentido, so ambguos ou que no podem ser satisfeitos. Exemplo: a) O que significam os termos numerao lgica, numerao fsica, consistncia entre numerao lgica e fsica e sinnimos? b) Quais so exatamente os itens de informao que formam um item bibliogrfico? c) Uma ficha tcnica composta de quais itens de informao?

4. Proposta de um Documento Textual de Requisitos do Usurio

Aplicando as diretrizes/propriedades e as regras de estruturao de especificao de requisitos, discutidas neste trabalho, no documento de requisitos do Sistema de Apoio Escrita (SAPES) apresentado na seo anterior, um novo documento de requisitos do SAPES foi desenvolvido e apresentado a seguir. Todos os termos em itlico do documento de requisitos fazem parte do lxico (dicionrio) do domnio da aplicao e so definidos detalhadamente no Apndice I (Vocabulrio Relativo ao SAPES). O Diagrama do Domnio da aplicao que inter-relaciona todos os termos do domnio apresentado no Apndice II. A. Viso Geral do Sistema O Sistema de Apoio Escrita (SAPES) tem como objetivo principal auxiliar a pesquisa bibliogrfica. Os usurios deste sistema so, principalmente, pesquisadores que durante a sua pesquisa bibliogrfica podem ler publicaes (por exemplo: artigos, livros e peridicos) e armazen-las no sistema atravs de itens bibliogrficos, construindo, assim, a sua bibliografia pessoal. Esta bibliografia pode ser alterada e

consultada conforme a necessidade do pesquisador, alm da possibilidade de fornecer diferentes tipos de relatrio. O pesquisador pode tambm utilizar o sistema durante a redao de textos cientficos. Atravs do documento produzido pelo pesquisador, o sistema reconhece as citaes e gera automaticamente a referncia bibliogrfica. B. Requisitos Funcionais B.1. Preparao e Manuteno dos Itens Bibliogrficos 1. O sistema deve permitir a insero, alterao e excluso de itens bibliogrficos, mantendo uma bibliografia.

15

2. O sistema deve solicitar ao pesquisador os itens de informao necessrios para inserir um item bibliogrfico na bibliografia. Os itens de informao so: ttulo, autor(es), data(ms/ano), local, resumo da publicao, assunto, numerao fsica, editora, peridico (volume, nmero, pginas), congresso e forma de citao. 3. O sistema deve fornecer mensagens de erro quando itens bibliogrficos incompletos

forem inseridos. Tais mensagens interrogam o pesquisador se deseja cancelar a operao de insero, completar as informaes incompletas ou concluir a insero assim mesmo. 4. O sistema deve, no caso de ocorrer a tentativa de insero de um item bibliogrfico

5.

6.

7.

8.

9.

j existente, comunicar ao pesquisador a existncia deste item bibliogrfico na bibliografia. Se, neste caso, o pesquisador confirmar a operao de insero, o sistema deve informar que tal operao ir alterar o item bibliogrfico existente. O sistema deve gerar automaticamente a forma de citao (cdigo de citao) seguindo o padro ABNT (Associao Brasileira de Normas Tcnicas) quando o pesquisador inserir um item bibliogrfico na bibliografia. O sistema deve fornecer facilidades para a criao e manuteno de uma lista de sinnimos, para os seguintes itens de informao do item bibliogrfico: autor, editora, peridico e congresso. O sistema deve permitir a alterao dos itens de informao de um item bibliogrfico da bibliografia, com exceo do cdigo de citao que gerado automaticamente pelo sistema. O pesquisador pode acessar/recuperar um item bibliogrfico pelos itens de informao: autor, ttulo e pelos sinnimos de autor e ttulo, respectivamente. O sistema deve permitir a excluso de um item bibliogrfico se este item existe na bibliografia. O pesquisador pode acessar/recuperar um item bibliogrfico a ser excludo pelos itens de informao: autor, ttulo e pelos sinnimos de autor e ttulo, respectivamente. O sistema deve permitir a insero de itens bibliogrficos importados de bibliografias de outros pesquisadores, atravs dos itens de informao autor e ttulo e tambm pelos sinnimos de autor e ttulo, respectivamente. O operao de

insero pode exigir ou no confirmao. A importao de itens pode ser total (todo a bibliografia do pesquisador) ou parcial (somente alguns itens bibliogrficos). 10. O sistema no deve permitir a alterao da bibliografia por parte de pesquisadores no autorizados (Segurana de Acesso).

B.2. Consultas Gerais e Emisso de Relatrios 11. O sistema deve permitir consulta a itens bibliogrficos existentes na bibliografia. A busca destes itens bibliogrficos pode ser realizada a partir dos seguintes itens de

16

informao ou combinao destes: autor, assunto, editora, peridico, local e ano de publicao. Assim, o sistema apresenta para o pesquisador todos o(s) item(s) bibliogrficos que satisfazem o critrio de busca. 12. O sistema deve, durante o processo de consulta, averiguar com o pesquisador quais itens de informao ele deseja recuperar. Assim, o sistema pode recuperar itens bibliogrficos totais ou parciais. 13. O sistema deve solicitar ao pesquisador, no momento da consulta o tipo do relatrio a ser gerado. O relatrio contm itens de informao relativos aos itens bibliogrficos selecionados pelo pesquisador durante o processo de consulta. Os relatrios podem ser impressos (na tela ou na impressora) ou podem ser gravados em arquivos para posterior anlise. 14. O sistema deve ordenar os itens bibliogrficos dos relatrios de acordo com a preferncia do pesquisador, utilizando as alternativas pelos itens de informao: autor, ttulo e pelos sinnimos de autor e ttulo, respectivamente. 15. O sistema deve fornecer recursos para a criao e impresso de fichas tcnicas a partir das informaes que o sistema possui sobre os itens bibliogrficos. Uma vez geradas as fichas tcnicas, o pesquisador pode optar por relatrio impresso ou gravao em arquivos. As fichas tcnicas contm alm dos itens de informao do item bibliogrfico, de forma parcial ou total, anotaes do pesquisador a respeito do item bibliogrfico.

B.3. Uso dos Itens Bibliogrficos durante a redao de um texto cientfico 16. O sistema deve percorrer o documento produzido pelo pesquisador a fim de identificar todas as citaes encontradas. A partir destas citaes o sistema deve gerar automaticamente a referncia bibliogrfica seguindo o padro ABNT, e que posteriormente ser anexada ao documento. As citaes no documento devem estar na forma ABNT. 17. O sistema deve permitir ao pesquisador ordenar as referncias das referncias bibliogrficas em ordem alfabtica por autor ou pela ocorrncia da sua respectiva citao no documento. 18. Caso o sistema encontre uma citao no documento que no esteja na bibliografia,

o sistema dever fornecer uma mensagem adequada ao pesquisador alertando a ocorrncia de uma possvel citao incorreta. 19. O sistema no deve permitir que o pesquisador altere as informaes geradas

automaticamente pelo sistema. Caso o pesquisador deseje alterar os itens de informao de uma referncia das referncias bibliogrficas por erro ou por no estar completa, ou deseje inserir um item bibliogrfico no encontrado pelo

sistema, este deve proceder com as alteraes desejadas na bibliografia e em

17

seguida o sistema deve percorrer novamente o documento gerando uma nova bibliografia. Caso no deseje fazer alteraes na bibliografia, dever ento fazer correes diretamente no documento. C. Requisitos de Qualidade Confiabilidade 20. O sistema deve ter capacidade para recuperar os dados perdidos da ltima operao que realizou em caso de falha. 21. O sistema deve fornecer facilidades para a realizao de backups dos arquivos do sistema. Eficincia 22. O tempo de processamento de uma operao de consulta no deve exceder trs segundos para uma quantidade inferior a 10 itens bibliogrficos. 23. O tempo de resposta para as operaes de insero, alterao e excluso no deve exceder a trs segundos.

Portabilidade 24. O sistema deve rodar em microcomputadores da linha IBM PC que possuam microprocessador 486 DX ou superior, memria RAM mnima de 8Mbytes e rodam sob Windows95. 25. O sistema deve ser facilmente portvel para o UNIX.

Esta nova verso do documento de requisitos est organizada dentro dos padres propostos, seguindo as diretrizes de especificao de requisitos apresentadas neste trabalho, tais como: O documento est organizado em torno de use-cases ou cenrios utilizados

pelo pesquisador: Preparao e Manuteno dos Itens Bibliogrficos, Consultas Gerais e Emisso de Relatrios e Uso dos Itens Bibliogrficos durante a redao

de um texto cientfico. Cada seo da especificao informal est numerada e cada requisito tem um identificador nico. Os requisitos esto separados em requisitos funcionais e no funcionais (qualidade). O texto no se refere a detalhes de implementao Os requisitos que no tm sentido e so ambguos foram eliminados. As inconsistncias foram eliminadas, apresentando as solues para resolv-las.

18

 Os termos do domnio so usados consistentemente. Explicaes dos termos relevantes do domnio da aplicao esto separadas da especificao dos requisitos e armazenadas no lxico do domnio (Apndice I).

5. Concluses Este trabalho apresentou uma viso geral da engenharia de requisitos,

enfatizando, principalmente, sua definio e o processo de engenharia de requisitos. De uma maneira geral, a engenharia de requisitos estabelece um processo de definio dos requisitos com o objetivo de obter uma especificao correta e completa dos requisitos. O produto deste processo um modelo que servir para produzir um documento de requisitos. Este documento serve como um meio de comunicao entre o projetista do software e o usurio a fim de estabelecer um acordo do software pretendido. Assim, o objetivo principal deste trabalho foi mostrar como um documento de requisitos deve ser organizado e redigido para que seja legvel, no ambguo e siga as diretrizes propostas por padres internacionais (por exemplo, Norma ISO/IEC 9126) quanto especificao de requisitos. Para alcanar tal objetivo, inicialmente foi apresentada uma verso de um documento de requisitos do Sistema de Apoio Escrita (SAPES). Este documento foi analisado e corrigido, dando origem a um novo documento organizado dentro dos padres propostos.

19

APNDICE I
Vocabulrio Relativo ao SAPES
que formam o lxico do domnio da aplicao. Este Apndice contm termos relevantes do documento de requisitos do sistema

Termo

Arquivo de Bibliografia

Definio

Idem ao termo Bibliografia.

Sinnimo

Bibliografia

Ver Tambm

Arquivo de Referncias Idem ao termo Referncia Referncia Bibliogrfica. Bibliogrficas Bibliogrfica Arquivo Texto Artigo Idem ao termo Documento. Texto com todas as citaes Trabalho especificadas pelo autor e com a referncia bibliogrfica j pronta e concatenada no final. um texto j publicado pelo pesquisador ou por qualquer outro autor. Documento

Artigo

Arquivo Texto, Documento

Bibliografia

o conjunto de todos os Arquivo de itens bibliogrficos de um Bibliografia pesquisador e estes itens se referem a publicaes de sua biblioteca. o conjunto de publicaes de um pesquisador, mantidos particularmente.

Biblioteca

Citao

Referncia a uma publicao em um documento, na forma de citao padronizada pela ABNT.

Referncia,

Referncia Bibliogrfica

20

Cdigo de Citao

Idem ao termo Forma de Forma Citao. Citao Arquivo que contm o texto Sinnimo sendo redigido pelo pesquisador, contendo citaes e que est pronto para ser manipulado pelo sistema SAPES.

de

Documento

Artigo,

Arquivo Texto

Ficha Tcnica

um carto retangular que contm informaes sobre um item bibliogrfico, servindo para consulta, para levar a uma conferncia ou reunio. Contm informaes resumidas sobre um item bibliogrfico. Esta ficha tcnica pode conter alm dos itens de informao do item bibliogrfico, de forma total ou parcial, conter tambm anotaes do pesquisador a respeito do item bibliogrfico. pela Cdigo ABNT, formada juntando-se Citao as trs primeiras letras do sobrenome do primeiro Forma normalizada autor, seguido do ano de publicao do item bibliogrfico. No caso de duas ou mais publicaes do mesmo autor no mesmo ano, de Citao

Forma de Citao

distinguem-se estas publicaes juntando com o ano da

21

Forma de Citao

publicao, as letras a Cdigo para a primeira publicao, Citao b para a segunda publicao e assim por diante. Por exemplo, [TUR95a], [TUR95b]. Esta forma usada na citao, entre colchetes, para identificar uma referncia dentro do documento.

de Citao

Identificao Bibliogrfico

do

Item Idem ao termo Citao

Citao

Forma Citao

de

Item Bibliogrfico

Cada verbete que descreve uma publicao. Um item bibliogrfico contm um conjunto de itens de informao sobre uma certa publicao.

Item de Informao

22

Item de Informao

Cada informao armazenada em um item bibliogrfico. As informaes mais comuns so: ttulo, autor (es), data (ms/ano), local da publicao. Outras informaes adicionais podem ser: resumo (pequena descrio da publicao), assunto, numerao fsica, editora, congresso, peridico (volume, nmero, pginas) e forma de citao da publicao.

Numerao Fsica

Pesquisador

Forma de classificao estabelecida pelo pesquisador para arquivar e recuperar publicaes em sua biblioteca particular. um item de informao do item bibliogrfico.

Publicao

a pessoa que utiliza o Usurio sistema SAPES e que est interessada na manuteno automatizada da Bibliografia. Qualquer divulgao envolvendo artigos, peridi-cos, livros ,anais, revistas e relatrios tcnicos. Um subconjunto de um item bibliogrfico, pertencendo a referncia bibliogrfica gerada para um determinado documento. Referncia Bibliogrfica meio de

Referncia

23

Referncia Bibliogrfica

Sinnimo

o conjunto de referncias a ser concatenado no final do documento que est sendo redigido pelo pesquisador no sistema SAPES. Representao abreviada do valor de qualquer item de

Arquivo de Referncia Referncias Bibliogrfica s

Trabalho Usurio

informao. Por exemplo, ao invs de registrar o nome completo de um autor, digamos Jos Carlos Bento de Saraiva, o pesquisador registra apenas JCBS. Idem ao termo Artigo Idem ao termo Pesquisador

Artigo

Pesquisador

24

APNDICE II
Diagrama do Domnio
todos os termos apresentados no Apndice I. Este Apndice contm o Diagrama do Domnio da aplicao que inter-relaciona

Numerao Fsica arquivado segundo Publicao possui uma Artigo composta por Biblioteca

Pesquisador

Bibliografia descrita por composta por Item Bibliogrfico d origem a representado por Itens de Informao Ficha Tcnica

redige

Documento contm Citao segue

contm

Referncia Bibliogrfica composta por Referncia d origem a

se refere a

Forma de Citao

25

Referncia Bibliogrfica

[Aur86] Aurlio Buarque de Holanda Ferreira. Novo Dicionrio Aurlio da Lngua Portuguesa. Segunda Edio - revista e ampliada). Editora Nova Fronteira, 1986. [Boe89] Boehm, B.W. Software risk management. IEEE Computer Society Press: Washington, 1989. [Boo91] Booch, G. Object-Oriented Design with Applications. Benjamin Cummings, CA, 1991. [Cas95] Castro, J. F. B. Introduo engenharia de requisitos. In: XV Congresso da Sociedade Brasileira de Computao, JAI'95, Canela, RS, Brasil, 1995, 43p. Prentice Hall, 1994. [Fio95] Fiorini, S.T.; Leite, J.C.S.P. & Soares, T.D.M. Integrando processos de negcio elicitao de requisitos. In: IX Simpsio Brasileiro de Engenharia de Software, [IEE84] IEEE Std. 830. IEEE Guide to Software Requirement Specification. The Institute of Electrical and Electronics Engineers. New York, 1984. [IEE90] IEEE Std. 610.12 IEEE Standard Glossary of Software Engineering [IEE91] IEEE Software: Measurement Based Process Improvement. july 1991, v.11(4). Quality characterisitcs and guidelines for their use. 1991. Terminology. The Institute of Electrical and Electronics Engineers. New York, 1990. SBES'95, Recife, 03-06 de outubro de 1995. p.379-394. [Col94] Coleman, D. et al. Object-Oriented Development: The Fusion Method.

[ISO9126] ISO/IEC 9126. Information Technology - Software Product Evaluation [Lei90] Leite, J.C.S.P. Validao de requisitos: o uso de pontos de vista. In: Revista [Lei94] Leite, J.C.S.P. Engenharia de Requisitos. In: Notas de Aula, PUC-RJ, 1994 [May90] Mayrhauser, A.V. Software Engineering: Methods and Management. Academic Press, 1990, 864p. [Pre94] Pressman, R.S. Software engineering: a practitioner's approach. Euopean Edition, 1994, 801p. Brasileira de Computao, v.6, n.2, p.39-52, RBC, outubro/dezembro 1990.

26