Autora: Elisabeth Hoffmann - GPS

A CELEPAR tem mantido, ao longo dos anos, processos de documentação de sistemas baseados na sua MDS (Metodologia de Desenvolvimento de Serviços).

FINALIDADE:

A finalidade de documentar sistemas é a de produzir manuais que sirvam de referência, seja na ausência do técnico responsável ou na transferência da responsabilidade pelo sistema.

A existência de documentação confiável possibilita a redução do tempo de manutenção dos sistemas, o reuso de soluções, a terceirização de atividades de manutenção e a detecção de falhas eventualmente existentes nos sistemas de produção.

Para os clientes é um complemento que agrega maior qualidade ao produto, demonstrando como utilizar todas as potencialidades oferecidas pelo sistema.

FASES DA DOCUMENTAÇÃO:

Passando por diversas fases, houve tempo em que as documentações eram datilografadas exigindo grande trabalho para se fazer alterações. Em um outro momento os textos passaram a ser editados no software DCF (Document Composition Facility) da IBM e VENTURA. Os modelos de documentos e relatórios eram anexados através de colagem, necessitando manter Pastas de Originais para fazer substituições e tirar cópias que se fizessem necessárias.

Atualmente, buscando facilitar o acesso a todos os que fazem uso da documentação está sendo utilizado o MS-WORD, software de uso geral da empresa. Os documentos produzidos são armazenados em uma base NOTES através de formulários e documentos anexados, o que possibilita:

• aos analistas, efetuar solicitação de confecção ou alteração das documentações, bem como agilizar o processo fornecendo um material prévio para a DITEC-F/Documentação;

• trâmite do material em desenvolvimento, vinculado a memorandos e histórico do processo, até o momento do término;

• armazenamento em local único, centralizando toda a documentação produzida oficialmente na CELEPAR;

• aos setores da produção, o acesso imediato a informações de alterações efetuadas pelos analistas;

• aos clientes, consultar suas respectivas documentações.

Os textos digitados em DCF, foram convertidos para WORD e anexados à base.

A base contém atualmente 43 Manuais de Análise e 44 Manuais de Sistemas (agregam em uma só publicação os Manuais de Análise, Cliente e Produção) estes, elaborados na primeira Metodologia utilizada pela CELEPAR. Tem-se ainda 36 Cartelas, 19 HELP, 55 Manuais de Produção, 95 Manuais e Guias de Usuário.

Foram atendidas 284 solicitações, desde a implantação da base (julho de 1999), que contemplam Publicação, Confecção, Alteração de Documentação e Solicitações de Pastas.

Os modelos de documentos e relatórios estão sendo digitalizados, tornando desnecessária a manutenção de Pastas de Originais.

FUNCIONAMENTO DA BASE NOTES DE DOCUMENTAÇÃO DE SISTEMAS:

Objetivos:

• Solicitação de Documentação: O solicitante envia dados básicos do serviço pretendido e pode anexar material que sirva de apoio e agilize o trabalho dos documentadores.

• Solicitação de Pastas: Solicitar pastas de Manual de Arquitetura e Documentário.

• Ao preencher esta solicitação estará também fazendo um registro na base, que possibilita saber quem é o analista responsável pelo aplicativo e localização das pastas referentes às informações técnicas e históricas do sistema.

• Modelos de Documentação: Modelos utilizados para a confecção de Manual da Produção e Manuais de Cliente sendo esses: Cartelas, Help, Guias de Usuário (usados em aplicativos de pequeno porte e que requerem pouca descrição) e Manuais de Usuário (usados em aplicativos de grande porte e que requerem maior quantidade de informações).

Estes modelos são apenas básicos e têm o objetivo de apresentar o mesmo layout para todas as documentações elaboradas na CELEPAR. Eles são adaptáveis e independem da plataforma tecnológica em que o sistema está sendo desenvolvido, ou seja, podem ser utilizados para aplicativos desenvolvidos em Mainframe, NOTES, Internet, Windows, Wap....

Visões:

•   Documentação:

• Sistemas: Mostra todos os sistemas que oficialmente possuem documentação na CELEPAR.

• Cliente: Mostra todos os sistemas que oficialmente possuem documentação na CELEPAR, classificada por cliente.

• Pastas: Mostra todos os registros de solicitações de pastas atendidas, classificadas por sistemas.

• Pastas por palavra-chave: Mostra todos os registros de solicitações de pastas atendidas, classificadas por palavra-chave.

• Solicitações:

• Sistemas: Mostra todas as solicitações, classificadas por sistema.

• Situação: Mostra todas as solicitações, classificadas por situação do trâmite.

• Solicitantes: Mostra todas as solicitações, classificadas por técnico solicitante.

• Avaliação: Mostra as avaliações feitas em relação ao serviço solicitado.

• Documentador: Mostra todas as solicitações, classificadas por nome do documentador que está atendendo o serviço.

CONCLUSÃO:

A criação da Base NOTES de Documentação foi um importante passo na evolução do processo de documentar e armazenar as documentações da CELEPAR. Porém, esta solução não é estanque, procura-se sempre agregar inovações e sugestões que possam vir a beneficiar o processo em geral.

Para que este processo alcance sua finalidade é necessário que haja um comprometimento geral, seja dos técnicos que documentam no sentido de buscar soluções que se adaptem à tecnologia utilizada ou dos analistas responsáveis pelos sistemas, no sentido de enviar as solicitações e fornecer as informações necessárias em tempo hábil, para se produzir documentações confiáveis e que possam contribuir para o armazenamento das informações e agregar qualidade aos sistemas oferecidos aos clientes.