Glossário: Processo e Produto

Engenharia de Requisitos GlossĂĄrio: Processo e Produto

Š FATTO Consultoria e Sistemas - www.fattocs.com

FATTO Consultoria e Sistemas ˜ Estimativas e Requisitos de Software Medic¸ao,

´ Glossario: Processo e Produto ˜ 2 Carlos Eduardo Vazquez1 , Guilherme Siqueira Simoes Resumo ´ ˜ do conhecimento e um recurso inestimavel ´ O glossario e´ um importante e reconhecido instrumento para a gestao para ˜ de software. Alem ´ de suas aplicac¸oes ˜ como um produto acabado, o proprio ´ ˜ a produc¸ao processo para sua elaborac¸ao, ˜ esta´ dispon´ıvel um ou mais glossarios, ´ ˜ para elicitac¸ao ˜ porque quando ja´ nao e´ um importante passo na preparac¸ao ˜ ˜ ´ ˜ fornece questoes a serem abordadas. Este texto trata dessas duas dimensoes do glossario explorando uma visao ´ de oferecer orientac¸ao ˜ pratica ´ ´ ˆ de produto e processo alem sobre como elaborar e manter um glossario no ambito da engenharia de requisitos.

Keywords ´ ˜ do conhecimento; elicitac¸ao ˜ de requisitos; analise ´ ˜ de requisitos; glossario; gestao de requisitos; gestao 1 FATTO

2 FATTO

Consultoria e Sistemas, carlos.vazquez@fattocs.com Consultoria e Sistemas, guilherme.simoes@fattocs.com

Conteudo ´

Ele respondeu meio sem grac¸a e baixinho:

˜ Introduc¸ao

1

1

˜ para elicitac¸ao ˜ Ferramenta de preparac¸ao

1

2 2.1 2.2 2.3

´ O que e´ o glossario 2 Onde encontrar . . . . . . . . . . . . . . . . . . . . . . . 2 Quando comec¸ar . . . . . . . . . . . . . . . . . . . . . . 3 O que definir . . . . . . . . . . . . . . . . . . . . . . . . . 3

´ 3 Como elaborar um glossario 3 3.1 Encontrar Termos Comuns . . . . . . . . . . . . . . . . 3 3.2 Vantagens . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 4

ˆ Referencias

3

˜ Introduc¸ao ´ meu coordenador me pediu de ultima Alguns anos atras ´ ˜ sobre o projeto que hora que participasse de uma reuniao comec¸ava: - O pessoal esta´ la´ no segundo andar discutindo sobre o ˜ vou poder participar e queria que voceˆ acompacvv2, nao nhasse para saber que impacto isso pode ter nos nossos ˜ acabou de comec¸ar, corre la. ´ sistemas. A reuniao Entrei na sala discretamente e sentei na cadeira mais ´ proxima da entrada. Estavam presentes umas 8 pessoas. A conversa estava adiantada, e o tal do cvv2 era citado a toda ˜ tinha ideia do que era aquilo. Sabia o que era hora. Mas nao ˜ Tentei entender a conversa por alguns cvv, mas o cvv2 nao. ˜ ia conseguir me situar. minutos ate´ que percebi que nao ˜ para fazer Estava com vergonha de interromper a discussao ˜ aproveitei que a conversa se essa pergunta banal. Entao concentrou num canto da mesa e perguntei em voz baixa no pe´ do ouvido de seu colega do lado: - Adriano, o que e´ cvv2?.

´ nao ˜ sei!.

- Tambem Imagine executar um projeto sem que todos os envolvidos ´ consigam entender todo o vocabulario de termos novos que um ele costuma envolver. Ou ainda, imagine que os envolvidos tenham entendimentos distintos sobre alguns termos usados. Acha dif´ıcil isso ocorrer? Pergunte o que significa “trem” para quem mora em Minas Gerais. Enquanto que para todos os demais brasileiros a resposta seja muito parecida com “ve´ıculo que anda sobre trilhos”, em Minas Gerais voceˆ descobrira´ que “trem” significa tudo, inclusive o veiculo que anda sobre trilhos! Ah, mas este exemplo ˜ tem nada a haver com a minha realidade, voceˆ pode nao pensar. Enta˜ experimente o termo “processo”. Dentro da mesma empresa voceˆ ira´ perceber diferentes significados, ´ dependendo da area que voceˆ abordar. ˜ usar Logo, problemas a` vista! Torna-se fundamental entao uma ferramenta para compartilhar esse conhecimento sobre ´ os termos e unificar entendimentos; e o glossario cumpre muito bem este papel. ´ Como produto final, o glossario e´ algo simples: uma lista ´ alfabetica de termos de um determinado dom´ınio de conhe˜ destes termos. Ainda que simples, cimento com a definic¸ao ˜ do conhecimento ene´ uma ferramenta poderosa na difusao ´ nao ˜ se deve restringir os tre as partes interessadas. Porem seus benef´ıcios somente ao produto final. O seu processo ˜ e´ tambem ´ uma oportunidade muito rica para de elaborac¸ao o analista de requisitos.

˜ para 1. Ferramenta de preparac¸ao ˜ elicitac¸ao ˜ do glossario ´ O processo de elaborac¸ao e´ um instrumento ˜ de diversas questoes, ˜ importante na descoberta e elicitac¸ao ´ ajudando na organizac¸ao ˜ das suas respostas. A tambem

´ Glossario: Processo e Produto — 2/4 ideia e´ que, descobrir as perguntas e as pessoas que podem fornecer as respostas muitas vezes e´ mais importante que descobrir as respostas para o limitado horizonte de perguntas conhecidas. ´ O filosofo Ludwig Wittgenstein teorizou que os limites de ˜ os limites de nosso mundo [Moura, nossa linguagem sao 2014]. Se restrito pelos limites de sua linguagem, o analista ´ ˜ de requisitos corre serios riscos de falhar em sua missao ´ por capturar e entender as necessidades do negocio e as desenvolver em um conjunto de requisitos que oferec¸am ˜ para elas. uma soluc¸ao Por exemplo, quando se estuda um documento com as ´ necessidades de negocio, surgem termos cujo significado preciso foge ao entendimento do analista de requisitos e de ˜ esteja inserida naquele dom´ınio qualquer pessoa que nao em particular. ˜ de escopo de Observe o trecho extra´ıdo de uma declarac¸ao ´ um projeto real para a area de engenharia: O escopo do Registro de Responsabilidade de ´ Obras de Medio e Grande Porte deve compreender os seguintes requisitos gerais: 1.

Obras com Registro Pendente;

2.

´ Formulario On-Line de Registro de Responsabilidade;

3.

´ ˜ Relatorios para Fiscalizac¸ao;

4.

´ ˜ da Fiscalizac¸ao. ˜ Relatorios para Gestao

˜ O leitor pode saber o que significa ”registro”, ”fiscalizac¸ao”e ˜ ”gestao”de maneira geral; mas sera´ que esse significado geral e´ suficiente para entender plenamente o seu significado no dom´ınio do problema?

Nesse simples trecho surgem pelo menos cinco termos que devem ter os seus significados explorados mais profundamente com o objetivo de obter (e confirmar) um melhor ˜ eles: entendimento sobre o dom´ınio do problema. Sao •

Registro de Responsabilidade;

•

Obra com Registro Pendente;

•

˜ da Fiscalizac¸ao; ˜ Gestao

•

´ Obras de Medio e Grande Porte;

•

˜ Fiscalizac¸ao;

˜ sera´ na analise ´ Possivelmente nao do documento que se obtera´ as respostas sobre o que cada um desses termos especificamente significa. Mas ele sera´ o ponto de partida ˜ de termos candidatos e com isso, compara identificac¸ao bust´ıvel (o que deseja-se enfatizar) para outras atividades ˜ de elicitac¸ao. ´ Organizar um glossario pode ser visto como predominan´ ´ temente uma atividade de analise ainda que analise e ˜ andem sempre juntas. O produto de um tipo elicitac¸ao de trabalho realimenta o outro em um processo evolutivo no ˜ sendo descobertos (revelados). Pela qual os requisitos vao ˆ sua importancia em gerar pauta para outras atividades de ˜ destacamos mais um benef´ıcio da elaborac¸ao ˜ de elicitac¸ao, ´ glossario. ´ ˆ O glossario, no ambito da engenharia de requisitos, deve ˜ de oportunidades de ampliar estar associado a` identificac¸ao

˜ a linguagem dos envolvidos no desenvolvimento da soluc¸ao ˜ sejam desnecessariamente limitados por de forma que nao ela.

´ 2. O que e´ o glossario ´ identifica e define termos chave para o dom´ınio O glossario ´ do problema, capturando o vocabulario comum das partes interessadas.

Antes de ser um produto especificamente da engenharia ´ ˆ de requisitos, o glossario e´ um ativo da gerencia do conheˆ cimento. A gerencia do conhecimento e´ um processo de ´ ˜ e uso dos ativos intelectuais negocio que formaliza a gestao ˜ Ela promove uma abordagem colabode uma organizac¸ao. ˜ para a criac¸ao, ˜ captura, organizac¸ao, ˜ rativa e de integrac¸ao ˜ incluindo o conheciacesso e uso de ativos de informac¸ao, ´ ˜ capturado das pessoas. mento tacito nao ´ Um exemplo e´ o Glossario Eleitoral Brasileiro [TSE, 2014], veja uma parte: •

˜ eleitoral: termo usado para deAbstenc¸ao ˜ ˜ [do eleitor] no ato finir a nao-participac ¸ ao ˜ eleitoral e´ de votar. O ´ındice de abstenc¸ao calculado como o percentual de eleitores ˜ se apresentam as ` que, tendo direito, nao ´ diferente dos casos em que o urnas. E eleitor, apresentando-se, vota em branco ´ ˜ ou anula o voto. Ver tambem: Justificac¸ao ˜ / Voto em branco / Voto de eleitor / Votac¸ao ´ obrigatorio.

•

˜ proibida: Ver Voto obrigatorio. ´ Abstenc¸ao

•

´ o ato de autoriAbuso de autoridade: E dade que, embora competente para praticar o ato, excede os limites de suas ˜ ou o pratica com fins diversos atribuic¸oes dos objetivados pela lei ou exigidos pelo ´ interesse publico.

Ver tambem: Abuso do ´ ˆ poder economico / Abuso do poder pol´ıtico ˜ de investigac¸ao ˜ judicial eleitoral / / Ac¸ao Crime eleitoral / Mandato eletivo.

•

ˆ Abuso do poder economico: O abuso de ˆ ´ poder economico em materia eleitoral se ˜ excessiva, antes ou refere a` utilizac¸ao durante a campanha eleitoral, de recursos materiais ou humanos que represenˆ tem valor economico, buscando benefi˜ afeciar candidato, partido ou coligac¸ao, tando assim a normalidade e a legitimi˜ ´ ˜ de dade das eleic¸oes.

Ver tambem: Ac¸ao ˜ de mandato eletivo. impugnac¸ao

2.1 Onde encontrar ´ ´ ˆ os seus glossarios; ´ Muitas areas de negocio tem o que e´ ´ otimo e pode facilitar muito o trabalho do analista de requi´ sitos. No entanto ainda que haja um glossario dispon´ıvel, cabe considerar desenvolver um especificamente para o projeto por dois motivos: (a) O potencial de haver diferentes ´ ˜ e (b) O seu processo de publicos usuarios da informac¸ao; ´ ˜ e respectivos direitos associados. atualizac¸ao

c FATTO Consultoria e Sistemas - www.fattocs.com C´opia licenciada para: issuu Proibida a reproduc¸a˜ o total ou parcial sem a permiss˜ao dos autores por escrito.

´ Glossario: Processo e Produto — 3/4 ´ do projeto, cada sistema deveria ter um glossario ´ Indo alem ´ ´ de complementar por exemplo o manual proprio.

Alem ´ ´ os projetos de de usuario (caso exista), facilitara´ tambem ˜ do mesmo sistema. Neste caso pode nao ˜ ser manutenc¸ao ´ ´ necessario criar um glossario para o projeto, reusa-se o do ´ do sistema os termos sistema, ou aproveita-se do glossario ´ ´ que podem ser necessarios compor o glossario do projeto.

2.2 Quando comec¸ar ˜ do glossario ´ deve ter in´ıcio conjuntamente com A elaborac¸ao ˜ ja´ quando se analisa o dom´ınio as atividades de elicitac¸ao ´ do problema e as necessidades de negocio (quanto mais cedo melhor) e deve ser atualizado de maneira cont´ınua conforme o analista de requisitos explora os requisitos das ˜ partes interessadas e especifica os requisitos da soluc¸ao. ` medida que as atividades de elicitac¸ao ˜ e analise ´ A progridem, o analista de requisitos identifica novos termos candi´ datos para compor o glossario, define os ja´ identificados e ˜ ` confirma a validade das definic¸oes que elaborou junto as partes interessadas com autoridade para isso. Eventual´ ajusta definic¸oes ˜ ja´ feitas. mente tambem 2.3 O que definir ˆ ´ Considerando-se a importancia de capturar um vocabulario ´ comum, deveria ser de uso obrigatorio em todos os projetos e acess´ıvel por todos da equipe de desenvolvimento e ˜ devem demais partes interessadas. Os termos e definic¸oes ˜ do glossario ´ precisa ser validados pelo cliente e a evoluc¸ao ´ de um responsavel, um dono. ´ O glossario deve incluir: •

´ termos tecnicos do dom´ınio do problema;

•

ˆ ˆ sinonimos e antonimos

•

˜ e acronimos; ˆ abreviac¸oes

•

termos do dia a dia com sentido espec´ıfico no dom´ınio do problema.

Fique atento ao feedback da equipe do projeto; porque se ´ tem duvidas ao longo do trabalho alguem sobre um termo ´ ˜ isso e´ uma pista que ele (ou mesmo o desconhece), entao ´ deveria compor o glossario (ou ser melhor explicado, caso ˜ ja´ possua uma definic¸ao).

´ 3. Como elaborar um glossario

˜ aliTermos cujo significado no dom´ınio do problema estao ˜ precisam estar no glossario, ´ nhados ao senso comum nao ´ sob o risco de sobrecarrega-lo. ´ O glossario deve ser atualizado conforme se avanc¸a no desenvolvimento dos requisitos, inicialmente, a partir das ´ necessidades de negocio e do dom´ınio do problema; em seˆ ˜ e explorando guida, consolidando a abrangencia da soluc¸ao ` os detalhes associados aquele escopo. ˜ entre os termos pode ser estruturada usando A correlac¸ao remissivas simples (“ver”, apenas remete ao termo que ´ a definic¸ao, ˜ usado para sinonimos) ˆ contem e remissivas cru´ zadas (“ver tambem”, remete a outros termos relacionados ´ que podem ser de interesse ao usuario) Avaliar os resultados ˜ inicial, quanto as suas atualizac¸oes ˜ devem Tanto a versao ` partes interessadas com a autoridade ser validadas junto as pelo assunto.

3.2 Vantagens ´ ˜ interna (entre O uso do glossario melhora a comunicac¸ao a equipe) e externa (com o cliente), porque diminui o poˆ ˜ dos termos tencial de haver divergencia na interpretac¸ao usados ao longo do desenvolvimento do projeto e que, sem ˜ promovida por sua utilizac¸ao, ˜ poderiam a uniformizac¸ao ´ ˜ causar serios problemas de comunicac¸ao. ˜ de tecnicas ´ Por exemplo, a aplicac¸ao como a entrevista ˜ em campo serao ˜ mais produtivas e efetivas ou observac¸ao ao elicitar os requisitos das partes interessadas quando o ˜ serao ˜ analista de requisitos conhece sua terminologia. Nao ´ ˜ a todo instante quando se discute necessarias interrupc¸oes determinado tema para explicar um termo ja´ definido no ´ glossario. ˜ e manutenc¸ao ˜ de outros documenEle simplifica a redac¸ao ˜ dos termos usados nao ˜ tos de requisitos, porque a definic¸ao precisa (nem deveria) estar presente nos demais documentos. ´ ˜ so´ para o O glossario e´ um documento importante nao ˜ preocupada com projeto de software. Toda organizac¸ao ˆ a gerencia do conhecimento deveria ter um (ou mais) ´ ´ glossarios sobre o seu negocio para permitir, por exem´ plo, que um novo funcionario tenha mais facilidade para se contextualizar, diminuindo a necessidade por treinamento e ´ nesse ambito ˆ acompanhamento. Haver um glossario facilita ˜ e analise ´ a elicitac¸ao de requisitos.

3.1 Encontrar Termos Comuns ˜ e analise ´ ´ A partir da elicitac¸ao das necessidades de negocio ˜ em suas diferentes representac¸oes e junto as partes interessadas chave, identificam-se os termos candidatos ao ´ glossario; especialmente aqueles: •

´ Unicos para o dom´ınio;

•

˜ Com mais de uma definic¸ao;

•

˜ local distinta do senso coCom definic¸ao mum; e

•

Com potencial de causar dificuldades de entendimento.

ˆ 4. Referencias [IIBA, 2009] IIBA - International Institute of Business Analysis (2005). A Guide to the Business Analysis Body of ˜ 2.0.

Knowledge R (BABOK R Guide). Versao [Gartner, 2014] Gartner Group.

IT Glossary. http://www.gartner.com/it-glossary/km-knowledgemanagement, acessado em 21/09/2014 ´ [Moura, 2014] Moura, Claudio M. 2014. Os Tortuosos Cami˜ Brasileira: Pontos de Vista Impopulares. nhos da Educac¸ao Editora Pensa.

c FATTO Consultoria e Sistemas - www.fattocs.com C´opia licenciada para: issuu Proibida a reproduc¸a˜ o total ou parcial sem a permiss˜ao dos autores por escrito.

´ Glossario: Processo e Produto — 4/4 [Pohl, 2011]. Pohl, K., Rupp, C.. Requirements Engineering Fundamentals. Rocky Nook Computing.

[TSE, 2014] TSE Tribunal Superior ´ Eleitoral.

Glossario Eleitoral Brasileiro. http://www.tse.jus.br/eleitor/glossario/glossario-eleitoral, acessado em 14/10/2014.

c FATTO Consultoria e Sistemas - www.fattocs.com C´opia licenciada para: issuu Proibida a reproduc¸a˜ o total ou parcial sem a permiss˜ao dos autores por escrito.