Este trabalho, foi apresentado para obtenção do título de Especialista no Curso de Pós-Graduação em Gestão da Informação e Inovações Tecnológicas à Fundação de Estudos Sociais do Paraná - FESP, objetivando analisar a adequação do processo de documentação de sistemas atualmente utilizado pela CELEPAR (Companhia de Informática do Paraná), através de literatura e pesquisas de campo.

As pesquisas bibliográficas demonstram a documentação de sistemas como um importante instrumento a ser utilizado, visando manter histórico dos projetos em todo o seu ciclo de vida, bem como demonstram sua importância como elemento integrante da qualidade do produto a ser entregue ao cliente.

As pesquisas de campo apresentam o processo de documentação de sistemas adotados por três empresas que desenvolvem software e expõem informações de opinião, coletadas através de questionário enviado aos técnicos da CELEPAR.

Neste momento o trabalho é apresentado de forma bastante resumida, porém existe versão completa, demostrando o processo de documentação da CELEPAR, bem como gráfícos e tabelas elaborados a partir das pesquisas efetuadas, que pode ser encontrada no Portfolio de Tecnologias e na biblioteca da empresa.

Introdução

A tecnologia da informação coloca à nossa disposição diferentes meios para armazenamento de informações. Registrar estas informações de forma que possam ser utilizadas por outras pessoas, permitindo seu aproveitamento, tem sido preocupação histórica do homem.

A documentação nos conta toda a história de um sistema, desde sua concepção, passando pelo seu desenvolvimento e acompanhando sua manutenção, mostrando-nos o que fazem, como fazem e para quem fazem. Ela inicia no momento da elaboração do primeiro relatório, segue descrevendo todas as fases das metodologia e durante o desenvolvimento do sistema devem ser elaborados os manuais.

[VALERIANO,1998], nos remete à importância de documentar um sistema, através da seguinte comparação: "Muitos projetos não nos legaram sua documentação nem qualquer de seus registros. De alguns, não se conhece nem mesmo seu objetivo, como os megálitos de Stonehenge, por exemplo. De outros, não se sabe como foram executados: as pirâmides egípcias, as das civilizações pré-colobianas e os monumentos da Ilha de Páscoa, apesar de serem muito admirados. Entretanto, da Arca de Noé, quer tenha sido real ou não, conhecem-se suas "especificações" bíblicas, o que permitiria construir uma "réplica", com razoável segurança."

A documentação faz com que os sistemas sejam da organização e não dependam das pessoas que nela trabalham [MONTÓN, 1979].

Megálitos de Stonehenge

Arca de Noé

Para os clientes é um complemento que agrega maior qualidade ao produto, demonstrando como utilizar todas as potencialidades oferecidas pelo sistema. Além disto, a documentação é um dos elementos exigidos para certificação ISO 9001 para garantir a qualidade no que se refere a projetos, desenvolvimento, produção, instalação e assistência técnica de sistemas de informação.

A documentação de sistemas e sua importância

Para [VALERIANO, 1998], o projeto enquanto em execução, é "hóspede" da organização até o seu término. A documentação é "filha" do projeto que a gera, enquanto ele estiver em execução. Quando o projeto terminar, a documentação sobreviverá a ele e, como "herdeira", retém toda a riqueza, todos os resultados, as virtudes e (por que não?) as deficiências e as carências do projeto.

A documentação, vista como uma ferramenta de auxílio a ser utilizada no momento de sua necessidade por todas as pessoas envolvidas com o sistema, precisa, para cumprir este papel, ser elaborada ao final de cada fase determinada pela metodologia adotada na organização para desenvolver seu sistema, bem como necessita ser atualizada sempre que houver uma modificação .

Metodologias de trabalho são adotadas, visando coordenar esforços das equipes de desenvolvimento, estabelecendo ordem, padrões e técnicas.

Existem diferentes soluções e formas de se determinar um modelo de metodologia a ser seguida. Geralmente ela é dividida em fases ou ciclo de vida e, mesmo considerando a ISO 9000-3 (Normas para a Gestão da Qualidade e Garantia da Qualidade) que define as diretrizes para aplicação da ISO 9001 (Sistemas de Qualidade - Modelo para Garantia da Qualidade em Projetos/Desenvolvimento, Produção, Instalação e Assistência Técnica), não há um padrão universalmente aceito. [BIO, 1993], descreve como regra geral, que as metodologias procuram definir:

> as etapas de um projeto;

> as atividades (geralmente pormenorizadas) de cada etapa;

> os produtos e pontos de controle das etapas/atividades;

> os responsáveis e demais envolvidos nas etapas/atividades;

> a documentação associada às atividades.

A justificativa para desenvolvimento de sistemas com aplicação de metodologia é assim apontada por [REZENDE, 2000]: "Todo e qualquer projeto, sistema ou software deve ser engenhado por meio de metodologia moderna e que ofereça a documentação completa. Toda a empresa deve ter uma metodologia, visando a efetividade, continuidade, perenidade, segurança e transparência, aceita e implementada pelos gestores, clientes/usuários e desenvolvedores."

Além de documentar cada fase é necessário elaborar os manuais durante o desenvolvimento dos sistemas. Os manuais normalmente sugeridos são:

> Manual do Sistema/Software (contendo todos as instruções pertinentes ao sistemas como: entradas, saídas, banco de dados, rotinas, programas, requisitos, etc.);

> Manual do Cliente/Usuário (contendo procedimentos de uso, dicas de problemas, etc.);

> Manual de Operação (contendo descrição de procedimentos/rotinas, periodicidade, dependência de informação, instruções de reprocessamento, retenção de arquivos, esquema de cópias, etc.). Este Manual tem a característica de ser elaborado quando o sistema/projeto é desenvolvido para plataforma mainframe.

Nas sugestões mencionadas acima, deve se considerar que o conteúdo e o tipo de manual a ser elaborado devem ser flexíveis, atender à realidade de cada projeto e a plataforma de desenvolvimento. Os documentos destinados ao usuário do projeto precisam "dar o recado", isto é, devem ser capazes de transmitir, com precisão e clareza, todas as informações de que o cliente necessita para usufruir o produto do projeto. Os documentos históricos constituem a memória do projeto e devem estar em condições de serem recuperados, consultados e entendidos em épocas posteriores, mesmo por pessoas que não estiveram direta ou indiretamente envolvidas com o projeto.

No que tange ao estudo da qualidade dos produtos [LOBO, 2002] afirma que: ‘...qualidade do produto é algo bom, mas que qualidade do processo de produção é ainda mais importante. No caso do software (...) diz-se mais sobre a qualidade observando como ele foi desenvolvido do que analisando o produto final. Afinal não se consegue ter certeza da manutenibilidade ou fidedignidade apenas usando a ferramenta".

A ISO/IEC 9126 (Tecnologia de Informação - Avaliação de Produto de Software - Características de Qualidade e Diretrizes para o seu Uso) ou NBR 13596 (tradução publicada em agosto de 1996), lista um conjunto de características que devem ser verificadas para que um software seja considerado um "software de qualidade". Entre estas características está a usabilidade, descrita também por [LOBO, 2002], como o esforço necessário para se utilizar o software, bem como o julgamento individual desse uso, por um conjunto de usuários implícitos ou explícitos. São características relacionadas: facilidade de compreensão, qualidade da documentação, aprendizagem e operabilidade.

A documentação está inserida num contexto de produção de variada gama de informações por pertencer ao processo de desenvolvimento de software, onde a qualidade e disponibilidade de informação sobre diferentes tipos de serviços influencia diretamente a qualidade e agilidade do processo e do produto, acumulando grande quantidade de documentos.

Face ao exposto, torna-se necessário considerar o gerenciamento, guarda, ou meio de armazenamento e trâmite dessas informações, através da adoção de instrumentos que permitam um acesso fácil à informação, através de interação simples e pronta, visível para toda a organização, que esteja de acordo com os perfis e critérios de segurança desejados. Isto garantirá que a informação seja confiável, atualizada e facilmente extraída. Estes instrumentos devem permitir não só o registro da informação, mas também a sua classificação de forma dinâmica e ajustada à realidade de cada organização. É também necessário que a informação armazenada seja estruturada de maneira a possibilitar diferentes formas de pesquisas e que o meio onde é acondicionada admita diferentes formatos de representação.

No que se refere à importância da Documentação de Sistemas, o ambiente complexo e rapidamente mutável  em que está inserido o desenvolvimento de software é agravado segundo, [FURLAN, 1994] "..pelas inconsistências, falta de documentação, redundâncias, dificuldades de acesso (...) bilhões de dólares são gastos anualmente em manutenção de sistemas no mundo inteiro."

[KETIS, 1999], afirma que : "Dados estatísticos demonstram que de 47% a 62% do tempo gasto em manutenção de sistemas é dispendido na tentativa de entender o programa, e que ler o código fonte custa 3,5 vezes mais do que ler a documentação. Além disso, 53% dos defeitos são descobertos em trechos tidos como corretos e 10% são introduzidos durante as alterações. Outros 64% dos defeitos são de lógica, enquanto 79% são causados por entendimento incorreto do problema."

Ainda segundo [KETIS, 1999], " o novo modelo organizacional (analista de informação, pool de analistas lógicos, pool de analistas físicos e programação interna ou terceirizada) implica na necessidade de fazer perfeita e completa documentação".

Cabe ressaltar que não basta apenas elaborar uma documentação inicial perfeita, é preciso também que a documentação elaborada inicialmente acompanhe cuidadosamente as manutenções e alterações efetuadas nos sistemas, para que seja mantida a integridade e confiança da informação contida na documentação. Não foram encontrados dados estimados de quantos dos sistemas são alterados e não documentados.

Alguns autores afirmam que a inexistência de documentação, faz com que os profissionais fiquem permanentemente na fase de manutenção, tornando-se impossibilitados de atuar em novos projetos e novos desafios, tendo dificuldades para repassar os serviços de manutenção ou contar com ajuda de outros técnicos. Já [MONTÓN, 1979] afirma que a inexistência de documentação faz com  que os profissionais se tornem ‘donos dos serviços’. - estes profissionais que normalmente têm toda a documentação em seu poder, tornam a empresa dependente de sua atuação, principalmente quando se trata de grandes projetos.

Considerando a proteção do software que, embora não seja patenteável, um programa de computador é protegido pelo Direito Autoral e para tal deve ser registrado no INPI. Para que o registro ocorra é necessária a documentação técnica relativa ao programa, que é arquivada sob guarda sigilosa, em envelope lacrado, e o INPI torna-se seu fiel depositário. A abrangência da proteção é internacional e o título é protegido juntamente com o programa em si por 50 anos.

Outros fatores que demonstram a importância da documentação de sistemas apontados por [KETIS, 1999] são:

> a legislação brasileira (Lei 9.430/96, de 27 de dezembro de 1996) obriga as pessoas jurídicas a manterem documentação atualizada de seus sistemas, para fins de auditoria por parte de organismos oficiais. A lei reproduz preceitos, antes esparsos na Legislação Federal, referentes ao acesso, retenção e guarda de documentação para efeito de fiscalização para possibilitar sua auditoria;

> resgate do ´know-how´ da organização: muitos sistemas podem e devem ser considerados ativos da organização, e como tal devem ter uma documentação confiável e segura;

> detecção de falhas eventualmente existentes nos sistemas: na atividade de documentação de sistemas, é possível encontrar erros de lógica que podem provocar resultados inesperados;

> liberação de recursos computacionais: a atividade de documentação de sistemas também permite reportar programas e trechos de código que não estão sendo utilizados;

> padronização para a certificação de qualidade: quando um sistema faz parte de um processo que está sendo preparado para uma certificação, torna-se necessário que tenha suas funções documentadas para efeito de auditoria;

> maior facilidade de entendimento do sistema: mesmo um profissional de informática que não conheça o sistema terá maior facilidade de entendimento pela utilização da documentação no lugar da utilização dos fontes dos programas;

> comunicação eficaz das informações entre as áreas envolvidas: quando a comunicação entre as áreas acontece formalmente e apoiada em documentos padronizados, a possibilidade de falha no entendimento fica reduzida. A formalização auxilia não só o destinatário mas o próprio remetente, visto que sua demanda será melhor explicitada.

Pesquisa de campo

> Questionário enviado aos técnicos da Celepar

Foi elaborado um questionário com o objetivo de coletar a opinião e sugestões dos analistas da CELEPAR em relação ao processo de documentação atualmente utilizado pela empresa.

O índice de retorno do questionário foi de 43%.

> Visitas

Para realizar as pesquisas, foram visitadas três empresas que desevolvem sistemas. Por questões éticas as empresas não foram identificadas e foram denomindas A, B e C. O objetivo das visistas foi verificar como as empresas armazenam e elaboram sua documentação.

> Quadros de análise das empresas pesquisadas

Principais pontos observados durante as visitas.

Conclusão

Após as verificações apresentadas, conclui-se que a CELEPAR possui um processo de documentação semelhante ao das empresas visitadas no que se refere ao uso de metodologia para desenvolvimento de sistemas e uso de padrões pré-elaborados que objetivam compor a documentação de forma completa e confiável. Destaca-se das demais empresas por possuir grupo técnico atuando especificamente na elaboração de manuais, controle dos documentos, elaboração de padrões, sugestão de inovações técnicas que produzem melhoria na forma do trabalho e suporte aos analistas para produzir, alterar e armazenar manuais.

Quanto à qualidade de seus projetos, a CELEPAR procura freqüentemente aperfeiçoar meios de avaliação de produtos, objetivando fornecer serviços que satisfaçam as necessidades dos seus clientes.

No armazenamento e trâmite das informações, a CELEPAR utiliza ferramentas que produzem efeitos similares ao das empresas visitadas, formando bases de dados em local único que possibilitam consultas, através do acesso rápido aos documentos produzidos. Neste ponto, há que se destacar a necessidade da unificação do local de armazenamento dos modelos utilizados para a elaboração dos projetos que atualmente não são encontrados na base específica para fins de documentação de sistemas.

A avaliação apresentada pelos técnicos da CELEPAR, através do questionário enviado, demonstrou que o processo de documentação de sistemas é conhecido e que existe consciência da importância da atividade de documentar os sistemas. Porém observou-se que eventualmente os técnicos iniciam a documentação determinada pela metodologia, mas não complementam todas as fases, bem como não armazenam toda a documentação produzida na base destinada para este fim.

No que se refere ao atendimento oferecido pelo grupo de documentação, observou-se que existe conhecimento e aceitação do trabalho desenvolvido pelos integrantes, mas que existem pontos a serem melhorados, principalmente quanto aos prazos de atendimento.

Verificou-se também que algumas das sugestões apresentadas pelos técnicos da CELEPAR ao responder o questionário aplicado, são passíveis de ser implementadas a curto prazo e que estas poderão contribuir para a melhoria do processo atualmente utilizado pela CELEPAR.

A pesquisa de campo efetuada demonstrou ainda que todas as empresas visitadas, incluindo a CELEPAR, possuem mecanismos que visam coletar, resguardar informações que produzem documentos e procuram aprimorar seus processos. Isto está ainda mais evidente no relato da empresa denominada como ‘B’, que apesar de ter processos bastante falhos, está consciente da necessidade de melhorá-los e pretende adquirir uma ferramenta que visa unificar o modo de desenvolvimento e meio de armazenamento em todos os seus pontos de atendimento.

As respostas ao questionário apontaram que: os técnicos conhecem a base de dados destinada ao armazenamento dos documentos, considerável número de técnicos afirmaram conhecer e utilizar a metodologia adotada pela empresa, conhecem a base de dados destinada a armazenar e tramitar informações referentes à documentação, atualizam documentações, conhecem os produtos elaborados pelo grupo de documentação já tendo solicitado serviços ao grupo e que as dificuldades apontadas para elaborar e alterar as documentações, na maioria dos casos, não apresentam vínculo com o processo adotado pela empresa. Outro ponto a ser considerado nesta análise foi o representativo percentual de técnicos que não ofereceram sugestões com o objetivo de propor melhorias.

Quanto à aplicação dos efeitos produzidos em função da realização deste trabalho, verificou-se que durante a sua confecção já foram efetuadas algumas mudanças que contribuíram para melhorar o processo atualmente utilizado e que outras contribuições poderão vir a ser implementadas.

Finalmente, conclui-se que a participação das empresas visitadas, bem como a contribuição dada pelos técncicos da CELEPAR através do questionário, teve um aspecto positivo no sentido de verificar que, apesar das dificuldades em se fazer o registro da documentação de um sistema desde o início da sua confecção, o acompanhamento de toda sua vida útil, e de praticamente não haver literatura científica específica que aborde o tema ´Documentação de Sistemas´, constata-se que o assunto tem importância relevante tanto no âmbito das empresas, quanto para os técnicos que atuam construindo sistemas de apoio à informação e que esta complementação de serviços permite que as organizações possam desempenhar suas atividades de forma mais eficaz e produtiva. Os meios utilizados para que estas documentações sejam registradas é que precisam constantemente ser reavalidados e adaptados, visto estarem inseridos num ambiente totalmente mutável como o da tecnologia da informação. Isto faz com que não se possa esperar que os meios hoje utilizados sejam compatíveis com a tecnologia disponível daqui a certo período de tempo. Desta forma como recomendação final, fica também a sugestão de que haja uma contínua reavaliação do processo e dos meios de armazenamento e a adequação necessária à tecnologia vigente.

Referências

1. ASSOCIAÇÃO BRASILEIRA DE NORMAS TÉCNICAS. NB - 9001 ISO 9001 Sistemas da qualidade - modelo para garantia da qualidade em projetos/desenvolvimento, produção, instalação e assistência técnica. Rio de Janeiro: ABNT, 1990. 8p.

2. ASSOCIAÇÃO BRASILEIRA DE NORMAS TÉCNICAS. NBR ISO/IEC 9126 Tecnologia de informação - avaliação de produto de software: características de qualidade e diretrizes para o seu uso. Rio de Janeiro: ABNT, 1994. 11p.

3. ASSOCIAÇÃO BRASILEIRA DE NORMAS TÉCNICAS. ISO 9000-3 Normas de Gestão da qualidade e garantia da qualidade: parte 3 - diretrizes para a aplicação da NBR 9001 ao desenvolvimento, fornecimento e manutenção de software. Rio de Janeiro: ABNT, 1993. 14 p.

4. BIO, S. R. Sistemas de informação: um enfoque gerencial. São Paulo: Atlas, 1993. 

5. FURLAN, J. D. Reengenharia da informação: do mito à realidade. São Paulo: Makron Books, 1994.6. KETIS, D. Terceirizando a documentação de sistemas. Developers’ CIO Magazine. Rio de Janeiro, v. 3, n. 36, p. 32-33, ago. 1999.

7. LOBO, A. Princípios de qualidade total aplicados a software: processo e produto. Disponível em: <http://pages.udesc.br/~r4al/qt.htm>. Acesso em: 27 mar. 2002.

8. MONTÓN, G. J. P. Documentação de sistemas, um mal necessário In: CONGRESSO NACIONAL DE PROCESSAMENTO DE DADOS, 12., 1979, São Paulo. Anais ...São Paulo: Sucesu, 1979, p. 153-163.

9. REZENDE, D. A.; ABREU, A. F. Tecnologia da informação aplicada a sistemas de informação empresariais: o papel estratégico da informação e dos sistemas de informação na empresas. São Paulo : Atlas, 2000.

10. VALERIANO, D. L. Gerência em Projetos - pesquisa, desenvolvimento e engenharia. São Paulo: Makron Books, 1998.