Se um médico fornece a você uma prescrição de um remédio e informa que está ocupado, não podendo incluir as instruções de quantas vezes e de qual quantidade você deverá tomar este remédio – qual seria a sua reação. Levando este raciocínio para o campo da informática, pergunta-se: Por que devemos liberar sistemas e não prover a documentação adequada?

Uma empresa atualmente não deve ter dificuldade e nem perder muito tempo para encontrar-se no padrão de qualidade ISO 9000 ou movimentar-se na escala do CMM (Capability Maturity Model).

Cabe observar aqui que o padrão ISO 9000 é feito de quatro partes:

• ISO 9001 - Serviços da indústria;

• ISO 9002 - Indústria de manufaturados;

• ISO 9003 - Hardware e Software de computador;

• ISO 9004 - Gerenciamento de qualidade.

Em essência, estes critérios de qualidade querem dizer que você deverá "planejar seus trabalhos e trabalhar seus planos", com a função extra de "documentar sempre seus planos e fazer sempre seus documentos".

O CMM tem 5 níveis de maturidade:

CMM Nível 1, classifica organizações quando o desenvolvimento de software e o processo de manutenção são caóticos por natureza. Indícios apontam para um ambiente de desenvolvimento que não é estável. Planejamento é ineficaz e não gerenciado. O compromisso de gerenciamento é dirigido por reação;

CMM Nível 2, introduz controle de gerenciamento básico onde os processos de software são repetitivos. Este é o primeiro estágio de qualidade;

CMM Nível 3, sugere que uma organização e seus processos estão adequadamente definidos, e há fácil gerenciamento de mudança;

CMM Nível 4, dita que o processo de software está bem gerenciado;

CMM Nível 5, é o estado de controle otimizado do processo.

Para alcançar o nível 5, sua organização deve basear-se nos seguintes alicerces: informação/negócios, aplicação e tecnologia. Processos devem ser bem documentados, acessíveis e repetitivos. Serviços e recursos devem ser reusáveis ou compartilháveis.

Documentação tem sido, ao longo do tempo, o calcanhar de Aquiles de muitas organizações de Tecnologia da Informação. Tão distante para atingir quanto para manter a documentação. O que parece ser um sonho impossível.

Parte do problema são, aparentemente, os intermináveis tipos de documentos que são requisitados (exemplo: plano da arquitetura da organização, instruções de trabalho, modelo conceitual, modelo lógico, modelo físico, modelo 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).

Da perspectiva da Tecnologia da Informação, realizar a documentação é fator crítico para o sucesso. Então, documentação é o centro dos componentes para suportar a gerência de mudança com sucesso.

Um aspecto que é colocado por alguns autores é o fato de que é necessário examinar o motivo pelo qual as organizações estão gastando bilhões de dólares com o problema do ano 2000, quando poderiam despender apenas um ou dois milhões. Pode-se dizer que a causa é a falta de uma "documentação" apropriada, ou a não existência da mesma. A documentação poderia ter diminuído o esforço e o tempo gasto para a conversão de sistema/software para o problema do ano 2000. Espera-se que no processo de conversão as organizações tenham tomado o cuidado de providenciar a documentação.

Com a documentação escolhemos a seqüência apropriada para desenvolver e migrar sistemas. Podemos gerenciar projetos, educar, antecipar, executar planejamento de capacidade, gerenciar expectativas, enfim, podemos nos situar nas mudanças.

Uma idéia a ser usada pela Tecnologia da Informação é de criar um "framework" para a documentação. Um exemplo desta técnica é o "Zachman Framework for Enterprise Architecture".

O Zachman Framework acomoda a documentação que é necessária para todos os setores da organização que competem pelos recursos da informação. O lay-out deste "framework" é uma grade 6 X 6. O eixo horizontal contém as interrogativas: o que/data, como/processo, onde/tecnologia, quem/organização, quando/tempo e por que/motivação. O eixo vertical oferece como perspectiva: o escopo do negócio, modelo do negócio, modelo do sistema de informação, modelo da tecnologia, definição da tecnologia e implementação. Cada célula é única, e esta documentação não tem sobreposição. A versão final deste "framework" é uma ampla visão da organização, horizontal e vertical, integrada dos documentos com níveis de detalhe. Esta visão final é ordenada, estruturada e precisa. Para o "framework" ter sucesso é necessário não sacrificar a qualidade da documentação em função do tempo.

O "framework" é um importante componente porque ele simplifica o gerenciamento de documentos. Sempre mais importante que o "framework", e mais importante que a qualidade e nível de detalhe da documentação é a acessibilidade do documento. Como exemplo disto citamos algumas situações que podem ter ocorrido nas organizações, como:

• Os documentos que um técnico necessitava, ficaram armazenados em algum lugar do disco local, e o responsável encontrava-se de férias, ficando a estação de trabalho protegida por "password";

• A organização ter detalhes de informações salvas em formato de arquivo em alguma ferramenta, que pode não ser lida pela maioria dos técnicos, isto porque eles não têm acesso a essa ferramenta;

• Documentos em papel que por alguma razão foram extraviados, não existindo cópia adicional, e nenhum controle sobre empréstimos, dificultando, assim, a localização dos documentos originais.

Outro passo importante da documentação é que esteja dentro do planejamento do ciclo de desenvolvimento de sistemas da organização. O planejamento deve conter algumas etapas, como as que relacionamos a seguir:

• Criar exemplos e listá-los;

• Documentar procedimentos;

• Capturar telas e listá-las;

• Fazer revisão técnica e edição;

• Imprimir documentação.

A documentação deve ser também considerada quanto ao seu conteúdo, qualidade, formato, inovação (tecnologia utilizada), rapidez de acesso, disponibilidade. E não se deve esquecer que toda documentação criada deve sofrer uma atualização periódica, de acordo com as mudanças ocorridas, para que a mesma possa refletir a realidade dos fatos.

Um projeto de Data Warehouse é uma boa maneira para iniciar a construção de sua infra-estrutura de documentação. O Warehouse descobre fontes de informações do que é importante para o negócio da organização. Em um ambiente de warehouse os metadados se constituem em um componente essencial, passando a gerenciar os seus dados.

O importante é que a organização tome consciência da questão de documentação em todos os seus níveis. É necessário que continue fazendo a documentação; documentando o processo; documentando seus novos sistemas.

FISHMAN, Neal A. Documentation for success. Dm Review, v. 8, n. 11, dez. 1998.