ISSN 0798 1015

Vol. 39 (Nº 37) Ano 2018 • Página 26

Qualidade da documentação utilizada para o desenvolvimento de softwares na ótica do design da informação

Quality of documentation used for the development of software from the point of view of information design

Júlio César FERREIRA 1; Sebastiana Luiza Bragança LANA 2

Recebido: 04/04/2018 • Aprovado: 19/05/2018

Conteúdo

1. Introdução

2. Metodologia

3. Resultados

4. Conclusões

Referências bibliográficas

1. Introdução

Estamos vivenciando perceptíveis transformações de melhorias sociais no mundo, graças às evoluções tecnológicas e a sua migração para setores produtivos e de serviços (ZUFFO, 2004). Baseado nessa afirmação, é possível concluir que, atualmente, o potencial para desenvolvimento de softwares é de extrema importância para os governos e para a sociedade. Porém, esse tipo de atividade possui altíssima dependência da documentação utilizada no projeto. Portanto, neste artigo, busca-se discutir a percepção dos profissionais envolvidos com o desenvolvimento de software em relação à qualidade da documentação disponível na atualidade. Ademais, definir, conceitualmente, os critérios relativos à qualidade da documentação a serem observados.

1.1. Documentação utilizada em projetos de software

O software, por ser abstrato, difere-se dos demais produtos concretos que possuem existência real em nosso mundo. Esse fator torna-o mais complexo, exigindo processos bem definidos para o seu desenvolvimento (MENDES, 2014). A produção de um software inicia-se com o levantamento de suas funcionalidades e de suas respectivas qualidades, conjunto definido como requisitos de software (VASQUES e SIMÕES, 2016).  Esse levantamento de requisitos e sua respectiva documentação são fundamentais, pois, caso sejam descritos de forma incompleta ou com dificuldades de real entendimento, podem comprometer a evolução do projeto, a funcionalidade e a qualidade do software em questão, como representado pela figura 1.

Figura 1
Importância do levantamento de requisitos

Fonte: adaptado pelo autor do site https://goo.gl/ZjhGw1

Portanto o sucesso de um projeto de software depende da qualidade da documentação dos requisitos (POHL; RUPP, 2012).

A engenharia tradicional se desenvolveu projetando e construindo produtos com existência física real, porém com o surgimento de máquinas que necessitavam de um software para funcionar surgiu a necessidade de se buscar uma forma de representa-lo pois se tratava de um produto abstrato. Nesse sentido, nas últimas décadas, vários métodos foram desenvolvidos com esse propósito, sendo que, atualmente, o mais empregado é o modelo baseado em cenários (PRESSMAN e MAXIN, 2016). Esse método se utiliza de atores responsáveis por representarem os usuários do sistema, interagindo com os casos de uso, estes que são utilizados a fim de descrever as funcionalidades desse software, tudo isso representado por meio de diagrama de fácil interpretação, denominados diagramas de casos de uso (GUEDES, 2013) demonstrado pela figura 2. O principal objetivo desse modelo é possibilitar o diálogo entre os responsáveis pelo desenvolvimento do software de maneira o mais simples possível de compreensão por parte daqueles que não conhecem de tecnologia mas conhecem as necessidades que o software deverá contemplar.

Figura 2
Diagrama de Casos de Uso

Fonte: adaptado pelo autor do site https://goo.gl/6esD8Q

A História de Usuário é uma técnica simples e ágil de documentar as funcionalidades do software (WILDT, MOURA, LACERDA e HELM, 2015), descreve as necessidades reais e práticas do usuário, de forma simples, curta e clara, a ponto de caberem em um pequeno cartão de papel (SOTILLE, MENEZES, XAVIER e PEREIRA, 2014). Deve ser composta por informações referentes a quem é o ator, qual a ação pretende executar e o resultado esperado após a execução da funcionalidade (SOTILLE, MENEZES, XAVIER e PEREIRA, 2014). A figura 3 demonstra uma história de usuário descrita em post-it.

Figura 3
História de Usuário

Fonte: produzido pelo próprio autor

Durante o processo de desenvolvimento de software, ocorrem, ciclicamente, fases distintas e que são denominadas: concepção, elaboração, construção e transição (PRESSMAN e MAXIN, 2016). Deve-se também considerar que, para cada uma dessas fases, a documentação deve fornecer informações específicas de acordo com a necessidade do momento, conforme representado pela figura 4.

Figura 4
Fases de um projeto de software

Fonte: produzido pelo próprio autor

1.2. Design da informação

Atualmente, a sociedade é muito dependente de informação, desse modo, a busca por se tornar competente nesse quesito passa pelos conceitos relacionados ao design da informação, cujos objetivos são a eficiência e a eficácia na localização e na interpretação dessas informações (DICK, GONÇALVES e VITORINO, 2017). Essa preocupação fez com que, em setembro de 2003, fosse realizado na UFP – Universidade Federal de Pernambuco, o primeiro encontro científico relacionado com o design da informação no Brasil, promovido pela SBDI – Sociedade Brasileira do Design da Informação, visto que esse tema já havia sendo tratado desde a década de 70 em outras partes do mundo (REDIG, 2004). Para estar alinhado aos conceitos relacionados com o design da informação, deve-se preocupar com o destinatário, buscando focar no receptor, na forma para otimizar a compreensão e no tempo observando a oportunidade de acesso e de estabilidade da informação transmitida (REDIG, 2004). O design da informação é uma arte capaz de organizar, selecionar, otimizar e transformar dados complexos em informações mais fáceis, úteis e efetivas (SOUZA, OLIVEIRA, MIRANDA, COUTINHO, FILHO e WAECHTER, 2016). Assim, essa informação fica perceptível no infográfico da figura 5.

Figura 5
Infográfico sobre design da informação

Fonte: http://anapalu.com.br/design-de-informacao/

O conhecimento científico pode ser entendido do ponto de vista lógico como sendo a teoria das demais teorias, além disso, encontra-se em constante mutação devido ao fato de se tratar de uma ciência empírica (POPPER, 2012). A ciência é o resultado de um procedimento, em que o objetivo é entender a realidade, podendo ou não haver uma intervenção nela. Para isso ocorrer, deve existir a formulação de problemas que determinem as ações e, consequentemente, quais os métodos a serem empregados (GERHARDT e SILVEIRA, 2009). Além disso, o conhecimento popular, também chamado senso comum, se diferencia do conhecimento científico, devido ao método e não em função da veracidade ou do objeto em si (MARCONI e LAKATOS, 2003).

A escolha das técnicas a serem empregadas na pesquisa deve levar em consideração o que será estudado e quais são as respostas que estão sendo buscadas, de modo que a condição básica para que esta ocorra é o emprego da metodologia científica (SOUZA, SANTOS e DIAS, 2013). Nesse sentido, o conhecimento a respeito da metodologia é de altíssima importância para a realização de qualquer pesquisa, porém, apenas isso não é o suficiente e, sim, um elemento essencial para o êxito da pesquisa (CIRIBELLI, 2003). Método pode ser entendido como sendo o procedimento ou conjunto de procedimentos necessários para a realização da pesquisa (CIRIBELLI, 2003).

O objetivo deste artigo é discutir a qualidade da documentação utilizada, atualmente, para o desenvolvimento de software, tanto do ponto de vista dos profissionais que atuam com esta atividade quanto na busca por um conceito baseado em estudos bibliográficos, referente a quais critérios devem ser avaliados para balizar o que deve ser considerado como qualidade da documentação. Logo, o projeto da pesquisa foi elaborado pensando em duas fases, cada qual utilizando métodos específicos de acordo com o seu propósito e descritos a seguir.

Primeira fase:

Buscou-se identificar a qualidade da documentação utilizada, atualmente, no desenvolvimento de software e, para isso, foi utilizada uma pesquisa de campo qualitativa, elaborada por meio de formulário online, utilizando a ferramenta gratuita disponível pela plataforma Google Forms. Esse formulário foi elaborado sem uma definição específica do que deveria ser considerado como qualidade da documentação, pois o propósito era ter respostas baseadas exclusivamente na percepção dos entrevistados, sem nenhum tipo de intervenção que pudesse balizar essas respostas. Esse formulário foi enviado a diversos analistas de sistemas, através de redes sociais, e ficou disponível entre os dias 18 de maio a 09 de setembro do ano de 2017.

Segunda fase:

A partir dos dados coletados na primeira fase iniciou-se uma pesquisa bibliográfica por intermédio de livros, de artigos, de dissertações e de teses, em busca de definir o conceito de qualidade da documentação utilizada em desenvolvimento de softwares, a fim de que ela servisse como referência na avaliação dos resultados apresentados pela pesquisa de campo.

3.1. Primeira fase da pesquisa

Durante o período em que esteve disponível, a pesquisa recebeu um total de 124 respostas. Conforme pode ser visto na figura 6.

Figura 6
Quantidade de respostas primeira fase da pesquisa

Fonte: produzido pelo próprio autor

As perguntas foram elaboradas de forma a identificar primeiramente o perfil profissional dos entrevistados e, na sequência, realizar questionamentos relacionados direta ou indiretamente sobre a qualidade da documentação utilizada em projetos de softwares. Os resultados dessa pesquisa de campo qualitativa são exibidos por meio dos gráficos comentados a seguir.

Figura 7
Qual seu grau de instrução?

Fonte: produzido pelo próprio autor

Como fica representado no gráfico da figura 7, podemos perceber que a grande maioria dos entrevistados possui curso superior completo, tal resultado se apresenta em torno de 65%, e, destes, a metade já concluiu também algum tipo de pós-graduação.

Figura 8
Quais as funções já atuou?

Fonte: produzido pelo próprio autor

Ainda buscando identificar o perfil dos entrevistados, a pergunta representada pela figura 8 serve para avaliar em quais tipos de atividades os entrevistados já atuaram em projetos de software. Os resultados apontam que a documentação (57,3%) é a segunda atividade mais exercida pela maioria, vindo atrás apenas da codificação (79%), por se tratar de uma atividade que normalmente exige muito mais mão de obra no projeto e, também, por ser fundamental para se ingressar no segmento de desenvolvimento de softwares.

Figura 9
Quais os tipos de empresas na área de TI você já atuou?

Fonte: produzido pelo próprio autor

A pergunta representada pelo gráfico da figura 9 é a última da série elaborada com o propósito de conhecer os entrevistados e serve para identificar em quais tipos de empresas eles já atuaram. O resultado demonstra que praticamente todos, cerca de 96% dos entrevistados, já atuaram ou atuam em empresa pública. Esse fator pode ser relevante devido à complexidade dos projetos que envolvem governo e, dessa forma, a demanda por profissionais é muito alta.

Figura 10
Em relação à maioria dos sistemas que você já trabalhou,
qual o nível de qualidade da documentação de software?

Fonte: produzido pelo próprio autor

A partir da figura 10, iniciam-se as perguntas relacionadas diretamente com a qualidade da documentação de software, sendo que, para essa primeira pergunta, busca-se identificar qual a percepção pessoal do entrevistado. Outro dado interessante a ser observado são as respostas possíveis: Documentação parcial e Documentação incompleta ou não possui, essas respostas, aparentemente idênticas, foram redigidas de forma que a primeira se trata de uma situação menos agravante que a segunda, pelo fato desta estar associada à condição de até mesmo não existir nenhum tipo de documentação. Podemos verificar com a soma desses resultados que algo em torno de 90% dos projetos de software possuem uma documentação incompleta, o que é muito grave, comparando-se com os demais segmentos mais tradicionais, por exemplo, a engenharia mecânica.

Figura 11
Uma boa documentação de software é algo:

Fonte: produzido pelo próprio autor

Para 91,1% dos entrevistados, conforme pode ser visto pela figura 11, uma boa documentação de software é difícil ou razoavelmente difícil de produzir, sendo que nesta pesquisa, deve-se levar em consideração as mesmas observações referentes à qualidade feitas anteriormente nos comentários da figura 10. Essa informação contribui com o entendimento da deficiência de qualidade da documentação utilizada atualmente, pois, muitas vezes, por ser trabalhoso, a equipe acaba optando por implementar sem que a documentação esteja feita ou atualizada, agravando cada vez mais essa situação. Logo, isso pode chegar a uma condição em que fique menos oneroso construir outro a partir do início, em vez de atualizar ou dar a manutenção necessária para um determinado software.

Figura 12
Qual a melhor forma de documentar?

Fonte: produzido pelo próprio autor

As respostas contidas na figura 12 se referem aos dois modelos mais empregados atualmente para a documentação de softwares, sendo o Caso de Uso considerado o mais tradicional, escolhido por 69% dos entrevistados e, além dele, a História de Usuário, uma outra forma desenvolvida recentemente. O resultado não significa que o Caso de Uso seja sempre o melhor, sendo que para cada situação de complexidade e de tamanho do projeto um ou outro pode ser o mais adequado.

Figura 13
Quais softwares robustos para documentação do
desenvolvimento de sistemas você conhece?

Fonte: produzido pelo próprio autor

Fica demonstrado, por meio da figura 13, que a grande maioria dos analistas de sistemas destacam apenas o Enterprise Architect e o IBM Rational Team Concert como ferramentas robustas, utilizadas para a documentação em projetos de softwares.

A pergunta a seguir, representada pela figura 14, busca analisar a hipótese de que, se ao desenvolver uma nova ferramenta para documentação de software, recursos de autenticação dos usuários poderiam ser utilizados para amenizar uma situação muito vivenciada por quem trabalha em projetos de grandes sistemas. Assim, essa ideia está resumida pela frase “Não foi isto que pedi!”, normalmente expressada pelo cliente, às vezes com razão e, em outros casos, não. Isso ocorre por se tratar de um produto virtual que somente através da documentação é possível definir o que deve ser produzido.

Figura 14
Em uma documentação de software online, a
validação através de usuário e senha do cliente:

Fonte: produzido pelo próprio autor

A autenticação por meio de usuário e senha é algo muito utilizado em diversos sistemas. A partir disso, o resultado representado pela figura 14 demonstra que, para a maioria dos entrevistados, esse tipo de recurso não irá inibir divergências durante o projeto.

Figura 15
Em relação ao uso de software livre na sua empresa:

Fonte: produzido pelo próprio autor

Software Livre é desenvolvido por comunidades e disponibilizado gratuitamente através da internet podendo ser instalado sem a necessidade do pagamento de licença para uso. Ademais, eles possuem o seu código aberto para que qualquer um possa colaborar com melhorias ou realizar alterações que lhe forem necessárias. O resultado do gráfico da figura 15 demonstra que as empresas não ficam muito presas pelo fato de ser software livre, apenas 35,5%. Portanto, o que pode ser entendido a partir das ideias apresentadas, é que o custo/benefício é o critério principal.

3.2. Segunda fase da pesquisa

Para esta fase foram identificados os conceitos relacionados à documentação de software e ao design da informação a serem pesquisados. Nesse sentido, os resultados são uma parte desses conceitos, disponíveis na introdução deste artigo, e a definição de qualidade da documentação, utilizada em projetos de software, resumida da seguinte forma: “A qualidade da documentação utilizada em projetos de software é diretamente proporcional a sua capacidade de entregar informações relevantes, de forma simples, tanto na busca quanto na interpretação dessa informação. ”

Por meio dos resultados desta pesquisa, concluiu-se que a maioria dos documentos utilizados atualmente em projetos de software são de baixa qualidade, uma boa documentação para desenvolvimento de software é relativamente difícil de ser produzida, o Caso de Uso seria a melhor metodologia a ser empregada, a condição de ser software livre não é muito relevante para a adoção de um determinado software, a validação através da autenticação por usuário e senha não irá impedir que ocorram divergências durante o desenvolvimento e por fim, as ferramentas mais conhecidas na atualidade para esse tipo de documentação são o Enterprise Architect e o IBM Rational Team Concert. A definição de qualidade da documentação utilizada em projetos de software está relacionada com a relevância da informação para o projeto, facilidade em localizar e interpretar esta informação. A partir de todos os resultados apresentados, é possível concluir que existe a necessidade de se buscar, em trabalhos futuros, soluções capazes de amenizar ou de extinguir os problemas identificados por esta pesquisa.

CIRIBELLI, M.C. Como elaborar uma dissertação de mestrado através da pesquisa científica. Rio de Janeiro: Viveiros de Castro Editora Ltda., 2003

DICK, M. E.; GONÇALVES, B. S. & VITORINO, E. V. Design da informação e competência em informação: relações possíveis. São Paulo: Revista Brasileira de Design da Informação, 2017.

GERHARDT, T. E.; SILVEIRA, D. T. Métodos de pesquisa. Rio Grande do Sul: Editora da UFRGS, 2009.

GUEDES, G.T.A. UML 2: Uma abordagem prática. São Paulo: Novatec Editora, 2013.

MARCONI, M. de A.; LAKATOS, E. M. Fundamentos de metodologia científica. São Paulo: Editora Atlas S. A., 2003.

MENDES, A. Custo de software: planejamento e gestão. Rio de Janeiro: Elsevier Editora Ltda, 2014.

POHL, K.; RUPP, C. Fundamentos da engenharia de requisitos: um guia para o exame CPRE-FL Certified Professional for Requeriments Engineering – Foundation level em conformidade com o padrão IREB. São Paulo: T&M Teste de Software Ltda, 2012.

POPPER, K. R. A lógica de pesquisa científica. São Paulo: Editora Cultrix, 2012.

PRESSMAN, R.S. e MAXIM, B.R. Engenharia de software: uma abordagem profissional. Porto Alegre: AMGH Editora Ltda, 2016.

REDIG, J. Não há cidadania sem informação, nem informação sem design. São Paulo: Revista Brasileira de Design da Informação, 2004.

SOTILLE, M. A.; MENEZES, L. C. de M.; XAVIER, L. F. da S.; PEREIRA, M. L. S. Gerenciamento do escopo em projetos. Rio de Janeiro: Editora FGV, 2014.

SOUZA, E. A.; OLIVEIRA, G. A. F.; MIRANDA, E. R.; COUTINHO, S. G.; FILHO, G. P.; WAECHTER, H. da N. Alternativas epistemológicas para o design da informação: a forma enquanto conteúdo. São Paulo: Revista Brasileira de Design da Informação, 2016.

SOUZA, G. S.; SANTOS, A. R.; DIAS, V. B. Metodologia da pesquisa científica: a construção do conhecimento e do pensamento científico no processo de aprendizado. Porto Alegre: Editora Animal, 2013.

VASQUES, C. E. e SIMÕES, G. S. Engenharia de requisitos: software orientado ao negócio. Rio de Janeiro: Brasport Editora, 2016.

WILDT, D.; MOURA, D.; LACERDA, G.; HELM, R. Extreme Programmning. São Paulo: Editora Casa do Código, 2015.

ZUFFO, J. A. A sociedade e a economia no novo milênio: os empregos e as empresas no turbulento alvorecer do século XXI. Barueri: Editora Manole Ltda., 2003.

Formulário online desenvolvido na plataforma Google Forms e utilizado na pesquisa de campo qualitativa.

1. Mestrando em Design pela UEMG - Universidade do Estado de Minas Gerais. Analista de Sistemas na empresa pública PRODEMGE - Companhia de Tecnologia da Informação do Estado de Minas Gerais. dbh.julio@gmail.com

2. Coordenadora Acadêmica Mestrado Design PPGD UEMG, doutora em Química pela UFMG, PhD em Engineering Materials – University of Sheffield, graduação  Geologia pela UFMG, sebastiana.lana@gmail.com