Documentação de Sistemas da Informação

    Necessidade ou preciosismo? A documentação de software, mesmo sendo o carma de qualquer desenvolvedor, é extremanente necessária e auxilia na redução de horas preciosas na correção de problemas,transferência de conhecimento, rastreabilidade rápidas para futuras melhorias e diminuição no custo de manutenção.

    Uma das etapas mais importantes no desenvolvimento de softwares é com certeza uma análise bem feita, com levantamentos de requisitos e uma boa modelagem de dados, porém deixar isso documentado é um importante legado e se estiver dentro dos padrões de um bom processo de desenvolvimento e aplicado em uma bem escolhida metodologia tem tudo pra dar certo.

    Normalmente, em grandes corporações existem pessoas e/ou equipes voltadas única e exclusivamente para a criação de documentação, sendo que o desenvolvedor fica restrito à codificação e comentários de seu código. Já no mundo "real", esta atividade é realizada pelo próprio desenvolvedor e demanda um bom conjunto de horas para planejar e criar cada uma de suas partes a fim de atender minimamente as necessidades do produto desenvolvido. O resultado dessa é em 95% dos casos a baixa qualidade na documentação final.

    thumb3

    A Server Consulting trabalha com três estratégias de documentação:

    - Pré-Implantação: Neste modelo a equipe de documentação trabalha junto com o Analista e/ou Desenvolvedor durante as fases de analise e desenvolvimento, antes de implantar o sistema em produção.

    - Pós-Implantação: Neste modelo a equipe de documentação trabalha com base nos fontes dos sistemas implantados, engenharia reversa da base de dados, levantamento dos processos, negócio e operação.

    - Legado-Unsourced: Neste modelo o cliente não dispõe dos fontes dos sistemas em funcionamento e com isso a equipe de desenvolvimento trabalha com engenharia reversa, levantamento dos processos, negócio e operação.

    A lista de documentos podem variar de acordo com a necessidade atual e futura do cliente, porém entre os componentes de documentação que a Server dispõe são os seguintes: Especificação Funcional, Não Funcional, Modelo de Dados, Dicionário de Dados, Protótipo, Casos de Uso, Diagrama de Casos de Uso, Diagrama de Sequência, Diagrama de Estado, etc.