Administração Documental em Engenharia de Software


 

Israel dos Santos Aguiar

Pós Graduação em Gestão de Tecnologia da Informação, Faculdade de Tecnologia e Ciências.

Rua Antonio Orrico, 357, São Judas Tadeu, Jequié-BA – Brasil.

isrbc@yahoo.com.br

 

Josué Costa Júnior

Pós Graduação em Gestão de Tecnologia da Informação, Faculdade de Tecnologia e Ciências. Rua Antonio Orrico, 357, São Judas Tadeu, Jequié-BA – Brasil.

josue@infocompus.com.br

 

Rafael Barbosa Neiva

Pós Graduação em Gestão de Tecnologia da Informação, Faculdade de Tecnologia e Ciências. Rua Antonio Orrico, 357, São Judas Tadeu, Jequié-BA – Brasil.

rafael@prodados.inf.br

 

Resumo

Projetos de engenharia sempre apresentaram a necessidade do registro e armazenamento de vários estados dos objetos (documentos de projeto) em tempos distintos. Tais projetos se caracterizam por possuírem estruturas complexas, coordenadas por grupos em diferentes ou em mesmos ambientes de cooperação. A documentação dos passos de um projeto é um recurso fundamental dentro desse tipo de ambiente facilitando o acesso às versões e a exploração do espaço de um projeto, permitindo o retorno a um ponto anterior para testes de alternativas, e o próprio controle do fluxo das tarefas. Uma documentação bem gerida é a garantia de um alto grau de satisfação na busca de melhores resultados em ambientes cooperativos.

 

Palavras-chave: Gestão, documentos, qualidade, organização e estrutura.

 

 

 

 

 

1. INTRODUÇÃO

 

Com o crescimento da tecnologia nos últimos anos, muitas fábricas de software tem se destacado neste mercado tão competitivo. Elas conseguem se diferenciar porque possuem uma engenharia de software eficiente e de qualidade. A busca constante da qualidade é o que faz com que os engenheiros e analistas procurem a cada dia métodos e processos eficientes para que possam criar um projeto que supra a necessidade do cliente, mas também que possa ser entendido por todos os envolvidos no projeto.

Dentro desta busca de qualidade os métodos utilizados para a Administração de Documentos merecem total ênfase, pois, o processo de elaboração de uma boa documentação que é aspecto essencial em todas as etapas de um projeto desde a sua concepção até a sua implantação só terá sentido se excelentes técnicas para a gestão desta documentação forem praticadas dentro da organização. Um projeto bem documentado já garante qualidade em todo o seu ciclo de vida. Contextualizando este conceito para o ambiente de projetos voltados para o desenvolvimento de software é importante frisar que a documentação neste ambiente merece total atenção, pois já se trata de um subproduto do software em desenvolvimento. Entretanto, dentro deste ambiente de desenvolvimento, em sua grande maioria, nem sempre a documentação detém a atenção devida, sendo assim negligenciada. O que resulta na inexistência de uma documentação formal dificultando as atividades de manutenção e correção de softwares.

Em muitos casos a documentação existente não segue uma padronização única, ou seja, cada desenvolvedor utiliza o seu próprio “estilo” para documentar criando uma diversidade de documentações sem padronização de difícil manutenção e entendimento. Fenômenos desta natureza ocorrem, em sua maioria, em decorrência de fatores como a falta de uma política organizacional adequada que valorize e gerencie essa tarefa, falta de ferramentas adequadas para apoiar a elaboração da documentação, prazos diminutos o que faz com que desenvolvedores optem por deixar a documentação em segundo plano e em muitas vezes a falta de conhecimento adequado em técnicas para gestão de documentos.

Este artigo discute a importância da elaboração da documentação integrada ao processo de desenvolvimento de software e a sua gestão. No contexto deste ambiente é importante frisar a padronização destes documentos. Eles permitem que modificações sejam mais facilmente realizadas, simplificando a tarefa de manutenção e evitando o retrabalho, assim como também discute a adequada gestão destes documentos como ferramenta estratégica no processo de produção de softwares.

Este artigo está estruturado em seções. A seção 2 discute brevemente o tema: gestão de documentos. A seção 3 discute brevemente o tema, a administração de documentos em Engenharia de Software. Na seção 4, é discutida a gestão de documentos como ferramenta estratégica para busca da qualidade. A seção 5 é apresentada uma ferramenta de apoio à documentação.

 

2. GESTÃO DE DOCUMENTOS

 

Uma boa gestão de documentos[1] tem como principal objetivo manter o histórico de tudo o que acontece durante a elaboração de um projeto, assim como o seu tempo de vida. As informações relativas a cada projeto devem ser armazenadas para que todos os participantes sem interessar o grau de hierarquia, possam ter as diretrizes para passos futuros.

O gerenciamento de documentação é também um caminho seguro, rápido e eficiente para as empresas se destacarem dos seus concorrentes, pois se torna uma poderosa aliada para a tomada de decisões e um facilitador para a gestão de suas atividades, sendo também uma espécie de “caminho” para a conquista de certificações ISO e de uma boa visibilidade no mercado de software.

Dentro dos processos da gestão documental podemos citar também o arquivamento adequado dos documentos elaborados, este “armazenamento” garante o controle, a confidencialidade e a rastreabilidade das informações. Este método possibilita ao gestor ter um acervo bem organizado e também se estabelece uma sistemática para remoção dos documentos obsoletos e a preservação dos documentos de valores históricos.

Em uma visão mais atual a qual valoriza o conteúdo informacional registrado nos documentos, Lopes (2000, p. 33) apresenta como conceito de arquivo os:

Acervos compostos por informações orgânicas originais, contidas em documentos registrados em suporte convencional ou em suportes que permitam a gravação eletrônica, mensurável pela sua ordem binária (bits); produzidos ou recebidos por pessoa física ou jurídica, decorrentes do desenvolvimento de suas atividades, sejam elas de caráter administrativo, técnico, artístico ou científico, independentemente de suas idades e valores intrínsecos.

No que diz respeito à administração da informação, o avesso de uma boa gestão documental é muitas vezes eminente entre várias organizações. Em seus arquivos, quando estes existem, nota-se grande deficiência e grande insuficiência informacional, pois há pouca propriedade intelectual estruturada e com isso o detalhamento dos projetos dos produtos não ficam acessíveis nas organizações. É fato que uma documentação bem elaborada e bem gerida, proporciona uma boa administração sobre produtos e decisões futuras, porém é fato também que muitos prejuízos poderão surgir decorrentes do processo decisório baseado em informação incorreta, custando enormes recursos financeiros empregados em processos redefinidos que não funcionam.

 

3. ADMINISTRAÇÃO DE DOCUMENTOS EM ENGENHARIA DE SOFTWARE

 

Contextualizando a gestão de documentos em um ambiente de desenvolvimento de sistemas a documentação de software [2] tem sido, ao longo do tempo, o maior desafio de muitas empresas de Tecnologia da Informação. Com isso problemas são identificados na produção e na manutenção na confecção desses documentos.

Parte dos problemas são, aparentemente, os intermináveis tipos de documentos que são requisitados (exemplo: plano da arquitetura, instruções de trabalho, modelo conceitual, modelo lógico, modelo físico, modelo de implementação, documentação de programas, documentação de sistemas, documentação do usuário, documentação técnica, planos de teste, planos de treinamento, e assim por diante). Porém, mesmo quando estes documentos requisitados são atendidos em parte, ou na sua totalidade, as empresas de tecnologia da informação ainda esbarram em outro grande problema, a ausência de uma boa administração de documentos.

Da perspectiva da Tecnologia da Informação, realizar a documentação é fator crítico para o sucesso, pois funciona como memórias descritivas de pesquisa e desenvolvimento. O sucesso de uma boa documentação está além das técnicas científicas para a elaboração dentro das várias etapas do desenvolvimento em Engenharia de Software, sejam estas etapas norteadas por modelos clássicos ou até mesmo ágeis onde a gestão de documentos tem menor ênfase.

Dentro da ótica da administração de documentos, que deve ser considerada como fator essencial ao pleno resultado para uma excelente documentação, BERNARDES e DELATORRE (2008, p. 6), afirmam que:

Somente a elaboração de um conjunto de normas e procedimentos técnicos para a produção, tramitação, avaliação, uso e arquivamento de documentos durante todo o seu ciclo de vida (idade corrente, idade intermediária e idade permanente), com a definição de seus prazos de guarda e de sua destinação final permite o desenvolvimento e a implementação eficaz de sistemas informatizados de gestão de documentos e informações.

Este conjunto de normas dará forma e organização coerentes, capazes de facilitar o acesso e a manutenção favorável aos registros de um desenvolvimento de um projeto de software. Para tanto tais normas devem prever: a produção de documentos dentro de uma elaboração padronizada de tipos ou séries documentais utilizando-se de sistemas de organização da informação e aplicação de novas tecnologias aos procedimentos administrativos; a utilização dos documentos incluindo todas as atividades de protocolo (recebimento, classificação, registro, distribuição, tramitação e expedição), todas as atividades de Arquivo (organização e arquivamento, reprodução, acesso à documentação e recuperação de informações) e a gestão de sistemas de protocolo e arquivo, sejam eles manuais ou informatizados; a tramitação que padroniza o controle do fluxo documental; a organização e o arquivamento; a reprodução visando à preservação do documento original; a classificação determinando a função e a atividade que gerou o documento e a avaliação identificando o ciclo de vida dos documentos estabelecendo prazos para a sua guarda e destinação.

A proposta dessas práticas normativas na administração de documentos dentro da Engenharia de Software culmina numa gestão documental por objetivos, os quais seriam: assegurar a agilidade no acesso aos arquivos e às informações promovendo a transparência das ações; garantir economia, eficiência e eficácia na administração dos processos de desenvolvimento; dinâmica do processo decisório; incentivo ao trabalho multidisciplinar e em equipe; controlar o fluxo de documentos e a organização dos arquivos e finalmente racionalizar a produção dos documentos.

 

4. GESTÃO DE DOCUMENTOS COMO FERRAMENTA ESTRATÉGICA PARA BUSCA DA QUALIDADE

 

A adequada administração de documentos é fator também preponderante para um melhor posicionamento da organização desenvolvedora de software diante do mercado, pois comprova o foco pela primazia da qualidade. Há muitos caminhos condutores à qualidade, ou, até mesmo, à excelência, que é a qualidade no seu papel de modelo para o desempenho das organizações. Um dos caminhos hoje mais enfatizados  – a ponto de se ter assemelhado a um modismo, tal a crescente adesão verificada nos quatro cantos do planeta, é o do uso das normas criadas  pela International Organization for Standardization (ISO) como instrumento voltado para assegurar a qualidade.

A ISO, nascida na Europa propõe a normalização de produtos e serviços com base em um padrão único, que seja reconhecido e implantado por vários países. A difusão das normas ISO pelo mundo ocorreu com grande rapidez, e, no Brasil, o fato se manifestou com maior intensidade na década de 90, logo após o lançamento, pelo governo,  do Programa Brasileiro de Qualidade  e Produtividade (PBQP).

Essas normas, conquanto hoje sejam tomadas como garantia ou até “sinônimo” de qualidade por razões de marketing, propõem que os processos de produção industrial ou de prestação de serviços sigam critérios rigorosamente estabelecidos por escrito e passíveis de  auditoria por terceiros a qualquer momento. Em alguns casos, até um mau produto pode receber a certificação ISO, desde que as etapas do processo de produção sejam registradas por escrito (documentação) e estabeleçam as providências a serem tomadas nos casos de não-conformidade, pois segundo Sommerville

O ISO 9000 está simplesmente relacionado com a definição de processos que serão usados em uma empresa e a documentação associada, como processos de controle que podem explicitamente mostrar que esses processos foram seguidos. Isso não está relacionado a garantia de que os processos refletem as melhores práticas ou com qualidade de produto.

Nos últimos anos o histórico da qualidade tem sofrido profundas transformações e por isso tem tomado, então, novos rumos. Segundo Barçante (1998, p. 2-3), ele pode ser dividido em quatro fases bem distintas: a Era da Inspeção, a Era do Controle Estatístico da Qualidade, a Era da Garantia da Qualidade e a Era da Gestão da Qualidade Total (TQM – Total Quality Management) ou, segundo Garvin (1992), a Era da Gestão Estratégica da Qualidade.

Uma primeira indagação que se poderia colocar é: por que razão uma empresa de desenvolvimento de software se interessaria por uma normalização técnica como a proposta pela ISO e não por outro sistema de gerenciamento da qualidade total? Essa necessidade de prestar serviços e ofertar produtos de qualidade surge porque, no atual cenário, os clientes usuários de software estão cada vez mais exigentes levando as organizações, dentro deste ambiente competitivo, a adotarem modelos inovadores de gestão. Para o corpo administrativo, a ISO prova sua eficácia, pois documentos, estratégias e ações têm respaldo por um manual que funciona como um verdadeiro guia de procedimentos.

A decisão de certificar-se percorre caminhos tais como: diagnosticar o momento inicial da empresa, encontrar rotas para melhorar a gestão da qualidade, definir metas a serem atingidas e avaliar, mediante o emprego de eficazes indicadores de desempenho, o próprio sistema. Por ser instrumento da qualidade, uma organização desenvolvedora de software que focar adequadamente em uma administração de recursos e processos que gerencie e padronize documentos, estará a caminho de um melhor diferencial em seu posicionamento estratégico diante de um mercado cujas exigências de eficácia, por razões de competitividade e sobrevivência, impuseram profunda transformação cultural no seio das organizações que valorizam as melhores práticas dentro dos conceitos da Engenharia de Software.

 

5. FERRAMENTAS DE APOIO À DOCUMENTAÇÃO EM ENGENHARIA DE SOFTWARE

 

A busca pela eficiência e pela qualidade no desenvolvimento de software, cada vez mais expõe problemas na fase de documentação dos projetos. Documentos sem padrões e sem vínculos com as fases dos processos são criados de modo a apenas cumprir o que as metodologias exigem na elaboração de documentos, mas os gestores não se preocupam em administrar a propriedade intelectual e o elo entre estas informações de modo a se vincular cada processo com os documentos.

Neste contexto, para que o processo de gestão de documentos seja de qualidade e o resultado da gestão faça diferença no mercado, é necessário que o ambiente ao qual o gestor esta inserido, seja estruturado de modo a prover recursos que utilizem ferramentas para apoiar todo o processo de gerência de informações. Essas ferramentas possuem características que permitem ao gerente controlar os documentos e os artefatos com administração das versões das informações e a ligação dos ciclos de cada processo.

Mas antes de expor as ferramentas de apoio é necessário citar ferramentas que auxiliam cada processo de desenvolvimento de software a gerar seus documentos e organizá-los. Um processo de software baseado no método tradicional de desenvolvimento é formado pelas seguintes etapas: elicitação e analise de requisitos, projeto, codificação, testes e manutenção.

Nestas etapas diversas ferramentas podem ser usadas para que seja preparada uma documentação adequada. Estas informações devem estar não só relacionada ao processo de desenvolvimento, descrevendo fases deste processo, arquitetura do sistema, diagramas de UML, como também é necessário documentação de uso do software utilizado, voltada para o cliente.

Para produção de documentação voltada para os desenvolvedores, serão abordadas as seguintes ferramentas:

  • Diagramação UML: Astah, Rational Rose
  • Modelagem de banco de dados: Dbdesigner, Mysql Workbench, Erwin
  • Documentação de códigos: javadoc
  • Editor de texto: BrOffice Writer, Microsoft Office Word
  • Controle de versão: Subversion (SVN), Current Version System (CVS), Git
  • Ferramenta colaborativa para documentação: Wiki

Diante das inúmeras quantidades de ferramentas, e documentação geradas, muitas vezes fica difícil organizar a documentação com diversas ferramentas. E ainda, esta documentação é modificada durante todo o processo de desenvolvimento. Sendo assim, certas modificações podem tornar-se inconsistentes, ou incoerentes. Para evitar esta inconsistência, é possível utilizar ferramentas que apóiem estas modificações, gerando versões dos documentos produzidos.

Devido à descentralização das empresas e por uma maior agilidade e produtividade, muitas empresas estão investindo em métodos de colaboração. Diretores, analistas, gerentes e desenvolvedores precisam manter um nível de comunicação e colaboração constante, porque muitas vezes eles não estão no mesmo ambiente físico e é necessário utilizar ferramentas para o gerenciamento dessas informações geradas durante o processo. Mas a realidade nas empresas não é este nível de organização e detalhamento. Desde o começo do ano 2000 surgiram ferramentas WIKI[3] para organizar e identificar um tipo especifico de coleção de documentos.

Um site Wiki tem um grande potencial para gerir a documentação de um projeto de software, a documentação gerada é publicada e fica online, o que garante a sua disponibilidade para todos os envolvidos no processo, seja ele gerente, analista, desenvolvedor e até mesmo os clientes, destacando a segurança nos dados e as restrições de acesso para cada envolvido. Uma característica importante nas ferramentas Wiki além de sua facilidade de escrita que se assemelha aos editores de textos usados nos projetos é um mecanismo de referencia que garante com que páginas sejam ligadas através de links, permitindo assim que pontos importantes de cada documento sejam linkados com outras paginas que explanem o seu significado.

As documentações dos projetos de software baseadas no Wiki possuem uma evolução gradual e organizada, permitindo editar e revisar as informações (páginas) de uma forma colaborativa e participativa, sendo acessadas dinamicamente por cada usuário. Todo processo segue as etapas da criação do software e essas etapas são interligadas através dos links que são criados nas páginas durante a documentação. Outro fator importante na ferramenta é que as versões de cada página são controladas automaticamente, permitindo o gerenciamento das versões e se usuários precisarem voltar versões anteriores de projetos, a qualquer momento isso pode ser feito.

Com o uso desta ferramenta para apoiar o gerenciamento dos documentos de um projeto de software é possível relacionar cada documento de cada etapa, e verificar a consistência das informações obtidas alterando dinamicamente qualquer parte do projeto, permitindo uma maior eficiência e qualidade na produção do software.

 

CONCLUSÃO

Os conceitos e discussões propostos neste artigo apresentaram como conseguir qualidade e eficiência com uma boa gestão de documentos assim como a utilização de ferramentas colaborativas, como a Wiki, para produção de documentos, garantindo controle e rastreabilidade resultando numa organização bem estruturada. A abordagem foi utilizada para evidenciar as características da administração documental que podem contribuir para o aumento da confiança à cerca dos produtos oferecidos pela organização, enfatizando também como todo processo desta administração é de grande importância para a produção de softwares e para as definições de metodologia de gestão documental, garantindo assim a qualidade do serviço e a credibilidade da empresa dentro do seu cenário de atuação.

A aplicação adequada de uma gestão de documentos em uma fábrica de software torna a produção de seus projetos mais concisa, mais eficiente e menos propenso a falhas. O resultado será produtos e serviços de qualidade aliados a uma imagem responsável da empresa. Resumidamente as vantagens da administração documental seriam:

  • Redução de custos com armazenamento de informação,
  • Pesquisa e recuperação de informação rápida e eficaz
  • Gestão de informação sem perda ou danificação da mesma
  • Integração de diversas documentações de forma estruturada

Dessa forma percebe-se que a gestão de documentos torna-se indispensável em uma empresa, pois organiza, mantêm, ou remove informações desnecessárias, e assim, contribui de forma essencial em todas as fases do desenvolvimento do produto final; desde sua concepção até a entrega ao cliente, apoiando, inclusive, no acompanhamento de todas as ações posteriores dos serviços prestados.

 

 

REFERÊNCIAS

 

ARQUIVO NACIONAL. Gestão de Documentos: conceitos e procedimentos básicos. Rio de

Janeiro, 1995. (Publicações Técnicas, 47).

 

BERNARDES, Ieda Pimenta; DELATORRE, Hilda. Gestão Documental Aplicada. São Paulo: Arquivo Público do Estado de São Paulo, 2008, 54 p.

 

BARÇANTE, Luiz Cesar. Qualidade total: uma visão brasileira. Rio de Janeiro: Campus,1998. 200p.

 

WIKIPEDIA, A enciclopédia livre.

http://pt.wikipedia.org/wiki/DocumentaC3%A7%C3%A3o_de_software  Acesso em 04/05/2011, às 20:23h
WIKIPEDIA, A enciclopédia livre.

http://pt.wikipedia.org/wiki/Wiki.  Acesso em 10/04/2011, as 22:14h
DEMING, William Edwards. Qualidade: a revolução da administração. Rio de Janeiro: Marques-Saraiva, 1990. 370p.

GARVIN, David. Gerenciando a qualidade: a visão estratégica e competitiva. Trad. Eng. João Ferreiro Bezerra de Souza. Rio de Janeiro: Qualitymark, 1992. 357p.

JARDIM, José Maria – O conceito e a prática de gestão de documentos. Acervo, Rio de Janeiro,2 (2): 35-42, jul.-dez. 1987.

 

LOPES, Luís Carlos. A gestão da informação: as organizações, os arquivos e a informática aplicada. Rio de Janeiro : Arquivo Público do Estado do Rio de Janeiro, 1997.

 

_______. A nova arquivística na modernização administrativa. Rio deJaneiro : [s. n.], 2000. 369 p.
RONDINELLI, Rosely Curi. Gerenciamento arquivístico de documentos eletrônicos: uma abordagem da diplomática arquivística contemporânea. Rio de Janeiro: Editora FGV,
2002.

Notas 


[1] A gestão documental ou gestão de documentos é um ramo do arquivo documental responsável pela administração de documentos nas fases corrente e intermediária (primeira e segunda idade). A definição completa pode ser encontrada em http://pt.wikipedia.org/wiki/Gest%C3%A3o_documental

 

[2] A documentação de software descreve cada parte do código fonte, geralmente uma função, uma classe, um simples trecho ou módulo. Consiste também no conjunto de manuais gerais e técnicos, além de diagramas explicando o funcionamento de um software como um todo ou cada parte dele.A definição completa pode ser encontrada em: http://pt.wikipedia.org/wiki/DocumentaC3%A7%C3%A3o_de_software

 

[3] Uma Web Wiki permite que os documentos sejam editados coletivamente com uma linguagem de marcação muito simples e eficaz, através da utilização de um navegador web.A definição completa pode ser obtida em: http://pt.wikipedia.org/wiki/Wiki