O glossário é um importante e reconhecido instrumento para a gestão do conhecimento e um recurso inestimável para a produção de software. Além de suas aplicações como um produto acabado, o próprio processo para sua elaboração, quando já não está disponível um ou mais glossários, é um importante passo na preparação para elicitação porque fornece questões a serem abordadas. Este texto trata dessas duas dimensões do glossário explorando uma visão de produto e processo além de oferecer orientação prática sobre como elaborar e manter um glossário no âmbito da engenharia de requisitos.
COMPETÊNCIAS: I - Compreender, identificar e aplicar normas legais atribuídas...
Glossário de termos técnicos para projetos de software
1. FATTO Consultoria e Sistemas
Medic¸ ˜ao, Estimativas e Requisitos de Software
Gloss´ ario: Processo e Produto
Carlos Eduardo Vazquez1, Guilherme Siqueira Sim˜oes2
Resumo
O gloss´ ario ´e um importante e reconhecido instrumento para a gest˜ao do conhecimento e um recurso inestim ´avel
para a produc¸ ˜ao de software. Al ´em de suas aplicac¸ ˜oes como um produto acabado, o pr ´oprio processo para sua
elaborac¸ ˜ao, quando j ´a n˜ao est ´a dispon´ıvel um ou mais gloss´ arios, ´e um importante passo na preparac¸ ˜ao para
elicitac¸ ˜ao porque fornece quest˜oes a serem abordadas. Este texto trata dessas duas dimens˜oes do gloss´ario
explorando uma vis ˜ao de produto e processo al ´em de oferecer orientac¸ ˜ao pr ´ atica sobre como elaborar e manter
um gloss´ ario no ˆambito da engenharia de requisitos.
Keywords
gloss´ ario; gest˜ao do conhecimento; elicitac¸ ˜ao de requisitos; an´ alise de requisitos; gest˜ao de requisitos;
1FATTO Consultoria e Sistemas, carlos.vazquez@fattocs.com
2FATTO Consultoria e Sistemas, guilherme.simoes@fattocs.com
Conte´udo
Introduc¸ ˜ao 1
1 Preparac¸ ˜ao para elicitac¸ ˜ao 1
2 O que ´e o gloss´ario 2
2.1 Onde encontrar . . . . . . . . . . . . . . . . . . . . . . . . 2
2.2 Quando comec¸ar . . . . . . . . . . . . . . . . . . . . . . . 3
2.3 Quando usar . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.4 O que definir . . . . . . . . . . . . . . . . . . . . . . . . . . 3
3 Como elaborar um gloss´ario 3
3.1 Encontrar Termos Comuns . . . . . . . . . . . . . . . . 3
3.2 Avaliar os resultados . . . . . . . . . . . . . . . . . . . . 3
4 Vantagens 3
Referˆencias 3
Introduc¸ ˜ao
Alguns anos atr´as um coordenador pediu de ´ultima hora a um
dos autores que participasse de uma reuni˜ao sobre o projeto
que comec¸ava:
— O pessoal est´a l´a no segundo andar discutindo sobre
o cvv2, n˜ao vou poder participar e queria que vocˆe acom-panhasse
para saber que impacto isso pode ter nos nossos
sistemas. A reuni˜ao acabou de comec¸ar, corre l´a.
Ele entrou na sala discretamente e sentou-se na cadeira
mais pr´oxima da entrada. Estavam presentes umas 8 pessoas.
A conversa estava adiantada, e o tal do cvv2 era citado a toda
hora. Mas ele n˜ao tinha ideia do que era aquilo. Sabia o
que era cvv, mas o cvv2 n˜ao. Ele tentou entender a conversa
por alguns minutos at´e que percebeu que n˜ao ia conseguir se
situar. Estava com vergonha de interromper a discuss˜ao para
fazer essa pergunta banal. Ent˜ao aproveitou que a conversa se
concentrou num canto da mesa e perguntou em voz baixa no
p´e do ouvido de seu colega do lado:
— Adriano, o que ´e cvv2?.
Ele respondeu meio sem grac¸a e baixinho:
— Tamb´em n˜ao sei!.
Imagine executar um projeto sem que todos os envolvidos
consigam entender todo o vocabul´ario de termos novos que
um ele costuma envolver. Ou ainda, imagine que os envol-vidos
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 vocˆe
descobrir´a que “trem” significa tudo, inclusive o veiculo que
anda sobre trilhos!
Logo, problemas `a vista! Torna-se fundamental ent˜ao usar
uma ferramenta para compartilhar esse conhecimento sobre os
termos e unificar entendimentos; e o gloss´ario cumpre muito
bem este papel.
Como produto final, o gloss´ario ´e algo simples: uma lista
2. Gloss´ ario: Processo e Produto — 2/4
alfab´etica de termos de um determinado dom´ınio de conhe-cimento
com a definic¸ ˜ao destes termos. Ainda que simples,
´e uma ferramenta poderosa na difus˜ao do conhecimento en-tre
as partes interessadas. Por´em n˜ao deve-se restringir os
seus benef´ıcios somente ao produto final. O seu processo
de elaborac¸ ˜ao ´e tamb´em uma oportunidade muito rica para o
analista de requisitos.
1. Preparac¸ ˜ao para elicitac¸ ˜ao
O processo de elaborac¸ ˜ao do gloss´ario ´e um instrumento
importante na descoberta e elicitac¸ ˜ao de diversas quest˜oes,
tamb´em ajudando na organizac¸ ˜ao das suas respostas. A 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 fil´osofo Ludwig Wittgenstein teorizou que os limites
de nossa linguagem s˜ao os limites de nosso mundo [2]. Se
restrito pelos limites de sua linguagem, o analista de requisi-tos
corre s´erios riscos de falhar em sua miss˜ao por capturar e
entender as necessidades do neg´ocio e as desenvolver em um
conjunto de requisitos que oferec¸am uma soluc¸ ˜ao para elas.
Por exemplo, quando se estuda um documento com as ne-cessidades
de neg´ocio, surgem termos cujo significado preciso
foge ao entendimento do analista de requisitos e de qualquer
pessoa que n˜ao esteja inserida naquele dom´ınio em particular.
Observe o trecho extra´ıdo de uma declarac¸ ˜ao de escopo de
um projeto real para a ´area de engenharia:
O escopo do Registro de Responsabilidade de
Obras de M´edio e Grande Porte deve compreen-der
os seguintes requisitos gerais:
1. Obras com Registro Pendente;
2. Formul´ario On-Line de Registro de Respon-sabilidade;
3. Relat´orios para Fiscalizac¸ ˜ao;
4. Relat´orios para Gest˜ao da Fiscalizac¸ ˜ao.
O leitor pode saber o que significa ”registro”, ”fiscalizac¸ ˜ao”e
”gest˜ao”de maneira geral; mas ser´a que esse significado geral
´e suficiente para entender plenamente o seu significado no
dom´ınio do problema quando da an´alise do documento?
Nesse simples trecho surgem pelo menos cinco termos
que devem ter os seus significados explorados mais profun-damente
com o objetivo de obter (e confirmar) um melhor
entendimento sobre o dom´ınio do problema. S˜ao eles:
Registro de Responsabilidade;
Obras de M´edio e Grande Porte;
Obra com Registro Pendente;
Fiscalizac¸ ˜ao;
Gest˜ao da Fiscalizac¸ ˜ao;
Possivelmente n˜ao ser´a na an´alise do documento que se
obter´a as respostas sobre o que cada um desses termos espe-cificamente
significa. Mas ele ser´a o ponto de partida para
identificac¸ ˜ao de termos candidatos e com isso, combust´ıvel
(o que deseja-se enfatizar) para outras atividades de elicitac¸ ˜ao.
Organizar um gloss´ario pode ser visto como predominan-temente
uma atividade de an´alise ainda que an´alise e elicitac¸ ˜ao
andem sempre juntas. O produto de um tipo de trabalho reali-menta
o outro em um processo evolutivo no qual os requisitos
v˜ao sendo descobertos (revelados). Pela sua importˆancia em
gerar pauta para outras atividades de elicitac¸ ˜ao, destacamos
mais um benef´ıcio da elaborac¸ ˜ao de gloss´ario.
O gloss´ario, no ˆambito da engenharia de requisitos, deve
estar associado `a identificac¸ ˜ao de oportunidades de ampliar a
linguagem dos envolvidos no desenvolvimento da soluc¸ ˜ao de
forma que n˜ao sejam desnecessariamente limitados por ela.
2. O que ´e o gloss´ario
O gloss´ario identifica e define termos chave para o dom´ınio
do problema, capturando o vocabul´ario comum das partes
interessadas.
Antes de ser um produto especificamente da engenharia
de requisitos, o gloss´ario ´e um ativo da gerˆencia do conheci-mento.
A gerˆencia do conhecimento ´e um processo de neg´ocio
que formaliza a gest˜ao e uso dos ativos intelectuais de uma
organizac¸ ˜ao. Ela promove uma abordagem colaborativa e de
integrac¸ ˜ao para a criac¸ ˜ao, captura, organizac¸ ˜ao, acesso e uso
de ativos de informac¸ ˜ao, incluindo o conhecimento t´acito n˜ao
capturado das pessoas.
Um exemplo ´e o Gloss´ario Eleitoral Brasileiro [4], veja
uma parte:
Abstenc¸ ˜ao eleitoral: termo usado para definir a n˜ao-participac
¸ ˜ao [do eleitor] no ato de votar. O ´ındice de
abstenc¸ ˜ao eleitoral ´e calculado como o percentual de
eleitores que, tendo direito, n˜ao se apresentam `as urnas.
´E
diferente dos casos em que o eleitor, apresentando-se,
vota em branco ou anula o voto. Ver tamb´em:
Justificac¸ ˜ao de eleitor / Votac¸ ˜ao / Voto em branco /
Voto obrigat´orio.
Abstenc¸ ˜ao proibida: Ver Voto obrigat´orio. Abuso de
autoridade: ´E
o ato de autoridade que, embora com-petente
para praticar o ato, excede os limites de suas
atribuic¸ ˜oes ou o pratica com fins diversos dos objeti-vados
pela lei ou exigidos pelo interesse p´ublico. Ver
tamb´em: Abuso do poder econˆomico / Abuso do poder
c FATTO Consultoria e Sistemas - www.fattocs.com
3. Gloss´ ario: Processo e Produto — 3/4
pol´ıtico / Ac¸ ˜ao de investigac¸ ˜ao judicial eleitoral / Crime
eleitoral / Mandato eletivo.
Abuso do poder econˆomico: O abuso de poder econˆomico
em mat´eria eleitoral se refere `a utilizac¸ ˜ao excessiva, an-tes
ou durante a campanha eleitoral, de recursos materi-ais
ou humanos que representem valor econˆomico, bus-cando
beneficiar candidato, partido ou coligac¸ ˜ao, afe-tando
assim a normalidade e a legitimidade das eleic¸ ˜oes.
Ver tamb´em: Ac¸ ˜ao de impugnac¸ ˜ao de mandato eletivo.
2.1 Onde encontrar
Muitas ´areas de neg´ocio tˆem os seus gloss´arios; o que ´e ´otimo
e pode facilitar muito o trabalho do analista de requisitos. No
entanto ainda que haja um gloss´ario dispon´ıvel, cabe con-siderar
desenvolver um especificamente para o projeto por
dois motivos: (a) O potencial de haver diferentes p´ublicos
usu´arios da informac¸ ˜ao; e (b) O seu processo de atualizac¸ ˜ao e
respectivos direitos associados.
2.2 Quando comec¸ar
A elaborac¸ ˜ao do gloss´ario deve ter in´ıcio conjuntamente com
as atividades de elicitac¸ ˜ao j´a quando se analisa o dom´ınio do
problema e as necessidades de neg´ocio (quanto mais cedo
melhor) e deve ser atualizado de maneira cont´ınua conforme
o analista de requisitos explora os requisitos das partes inte-ressadas
e especifica os requisitos da soluc¸ ˜ao.
`A
medida que as atividades de elicitac¸ ˜ao e an´alise pro-gridem,
o analista de requisitos identifica novos termos can-didatos
para compor o gloss´ario, define os j´a identificados
e confirma a validade das definic¸ ˜oes que elaborou junto `as
partes interessadas com autoridade para isso. Eventualmente
tamb´em ajusta definic¸ ˜oes j´a feitas.
2.3 Quando usar
Considerando-se a importˆancia de capturar um vocabul´ario
comum, se recomenda o uso obrigat´orio e acess´ıvel por todos
da equipe de desenvolvimento e demais partes interessadas.
2.4 O que definir
O gloss´ario deve incluir:
termos t´ecnicos do dom´ınio do problema;
abreviac¸ ˜oes e acrˆonimos;
sinˆonimos e antˆonimos
termos do dia a dia com sentido espec´ıfico no dom´ınio
do problema.
Fique atento ao feedback da equipe do projeto; porque se
ao longo do trabalho algu´em tem d´uvidas sobre um termo (ou
mesmo o desconhece), ent˜ao isso ´e uma pista que ele deveria
compor o gloss´ario (ou ser melhor explicado, caso j´a possua
uma definic¸ ˜ao).
3. Como elaborar um gloss´ario
3.1 Encontrar Termos Comuns
A partir da elicitac¸ ˜ao e an´alise das necessidades de neg´ocio
em suas diferentes representac¸ ˜oes e junto as partes interessa-das
chave, identificam-se os termos candidatos ao gloss´ario;
especialmente aqueles:
U´ nicos para o dom´ınio;
Com mais de uma definic¸ ˜ao;
Com definic¸ ˜ao local distinta do senso comum; e
Com potencial de causar dificuldades de entendimento.
Termos cujo significado no dom´ınio do problema est˜ao
alinhados ao senso comum n˜ao precisam estar no gloss´ario,
sob o risco de sobrecarreg´a-lo.
O gloss´ario deve ser atualizado conforme se avanc¸a no
desenvolvimento dos requisitos, inicialmente, a partir das ne-cessidades
de neg´ocio e do dom´ınio do problema; em seguida,
consolidando a abrangˆencia da soluc¸ ˜ao e explorando os deta-lhes
associados `aquele escopo.
A correlac¸ ˜ao entre os termos pode ser estruturada usando
remissivas simples (“ver”, apenas remete ao termo que cont´em
a definic¸ ˜ao, usado para sinˆonimos) e remissivas cruzadas (“ver
tamb´em”, remete a outros termos relacionados que podem ser
de interesse ao usu´ario)
3.2 Avaliar os resultados
Tanto a vers˜ao inicial, quanto as suas atualizac¸ ˜oes devem ser
validadas junto `as partes interessadas com a autoridade pelo
assunto.
4. Vantagens
O uso do gloss´ario melhora a comunicac¸ ˜ao interna (entre a
equipe) e externa (com o cliente) porque diminui o poten-cial
de haver divergˆencia na interpretac¸ ˜ao dos termos usa-dos
ao longo do desenvolvimento do projeto e que, sem a
uniformizac¸ ˜ao promovida por sua utilizac¸ ˜ao, poderiam causar
s´erios problemas de comunicac¸ ˜ao.
Por exemplo, ao elicitar os requisitos das partes interes-sadas,
uma vez que se o analista de requisitos conhece sua
terminologia, a aplicac¸ ˜ao de t´ecnicas como a entrevista ou
observac¸ ˜ao em campo ser˜ao mais produtivas e efetivas. N˜ao
ser˜ao necess´arias interrupc¸ ˜oes a todo instante quando se dis-cute
determinado tema para explicar um termo j´a definido no
gloss´ario.
Ele simplifica a redac¸ ˜ao e manutenc¸ ˜ao de outros documen-tos
de requisitos porque a definic¸ ˜ao dos termos usados n˜ao
precisa (nem deveria) estar presente nos demais documentos.
c FATTO Consultoria e Sistemas - www.fattocs.com
4. Gloss´ ario: Processo e Produto — 4/4
O gloss´ario ´e um documento importante n˜ao s´o para o
projeto de software. Toda organizac¸ ˜ao preocupada com a
gerˆencia do conhecimento deveria ter um (ou mais) gloss´arios
sobre o seu neg´ocio para permitir, por exemplo, que um novo
funcion´ario tenha mais facilidade para se contextualizar, di-minuindo
a necessidade por treinamento e acompanhamento.
Haver um gloss´ario nesse ˆambito facilita a elicitac¸ ˜ao e an´alise
de requisitos.
Referˆencias
[1] IIBA - International Institute of Business Analysis (2005).
A Guide to the Business Analysis Body of Knowledge
R
(BABOK
R Guide). Versa˜o 2.0.
[2] Moura, Cl´audio M. (2014). Os Tortuosos Caminhos da
Educac¸ ˜ao Brasileira: Pontos de Vista Impopulares. Editora
Pensa.
[3] Gartner Group. IT Glossary. http://www.gartner.com/it-glossary/
km-knowledge-management, acessado em
21/09/2014.
[4] TSE - Tribunal Superior Eleitoral. Gloss´ario Eleitoral
Brasileiro. http://www.tse.jus.br/eleitor/glossario/glossario-eleitoral,
acessado em 14/10/2014.
c FATTO Consultoria e Sistemas - www.fattocs.com