Documentação de Software

Transcrição

1 ISO/IEC 12207: Documentação de Software

2 Registra a evolução do software para que sejam criadas as bases necessárias para uma melhor utilização e manutenção do software Estima-se que de 20% a 30% de todo o tempo empregado no desenvolvimento de um software é dedicado di d à elaboração de sua documentação É importante que o documento retrate fielmente o software, de modo que atividades como avaliação e modificação do software possam ser realizadas sem maiores transtornos

3 Muitos outros benefícios são obtidos a partir de uma documentação cuidadosamente elaborada, tais como: Redução no tempo e do esforço despendidos no desenvolvimento do software Facilidade e maior eficiência no manuseio do software por parte dos usuários Facilidade de localização das informações e melhor compreensão das estruturas do software

4 Por outro lado, existem aspectos preocupantes com relação à produção de documentos Fatores como altos custos, imprecisão e dificuldade na manipulação comprometem a criação e a atualização dos documentos A combinação destes fatores inevitavelmente acarreta documentos incompletos, desatualizados, inconsistentes e caros de se manter

5 A inconsistência em documentos de software também pode ser decorrente da ausência de um relacionamento mais explícito entre os documentos, uma vez que estes registram isoladamente uma determinada etapa ou atividade do desenvolvimento do software Durante o desenvolvimento do software, é comum a ocorrência de três situações Software construído paralelamente à sua documentação Software construído antes de sua documentação Software construído sem que nenhuma documentação tenha sido redigida

6 As duas últimas situações podem ser explicadas pelo fato que muitos engenheiros de software consideram a documentação uma tarefa burocrática no desenvolvimento do mesmo Embora reconheçam que documentar software é importante, na prática a consideram uma atividade exigente que toma tempo e energia

7 Tradicionalmente, pouca antenção tem sido dada à documentação gerada durante os projetos de desenvolvimento Isso gera documentos mal-elaborados, de difícil compreensão, inadequados ou até mesmo incompletos A falta de um projeto de documentação tem atrapalhado a manutenção do software durante toda a história da computação

8 A utilidade do software também tem sido degradada por não se ter disponíveis informações corretas sobre todas as possibilidades oferecidas pelo produto de software desenvolvido Por essas razões, a elaboração de uma documentação técnica de qualidade relacionada ao processo de software é tão importante quanto a qualidade do software em sí

9 Implementação do Processo O objetivo desta atividade é estudar os requisitos de documentação do projeto de software a ser desenvolvido, criando um plano de documentação em que são estabelecidos, entre outras coisas: o tipo de documento a ser desenvolvido a tecnologia a ser usada a seqüência de operações para a produção a distribuição dos documentos

10 Implementação do Processo A linguagem que será usada na indexação e referência também deve ser definida aqui Essa linguagem é importante, pois facilitará o trabalho do pessoal envolvido no desenvolvimento do software, que constantemente precisa consultar documentos previamente elaborados no projeto Devem ser identificados termos para referência / indexação a fim de facilitar a localização do documento para consulta ou modificação Este plano é o ponto de partida para a atividade id d seguinte, que é o projeto e desenvolvimento do documento

11 Implementação do Processo A seqüência de atividades a ser realizada durante a fase de implementação é: Identificação dos requisitos de documentação Identificação dos documentos e de suas relações Estabelecimento da organização dos documentos Elaboração de um plano de produção e distribuição Elaboração de um plano de definição da linguagem do documento Um estudo das diferentes tecnologias alternativas

12 Implementação do Processo Para cada um dos documentos identificados, devem ser fornecidos o título ou nome, o propósito, p a que se destina, os procedimentos e responsabilidades para entradas, desenvolvimento, revisão, modificação, aprovação, produção, armazenamento, distribuição, manutenção e gerenciamento de configuração e o cronograma para versões intermediárias e finais

13 Projeto e Desenvolvimento Uma vez estabelecida no plano a maneira como o processo de documentação será realizado,,prossegue-se para a descrição, na forma de diferentes modelos conceituais, de todos os aspectos exigidos para a produção de cada documento: Estrutura interna Características de apresentação Hipermídia Etc

14 Projeto e Desenvolvimento Cada documento identificado deve ser projetado de acordo com determinados padrões de documentação, como: Formato Conteúdo Descrição Numeração de páginas Localização de figuras e tabelas Propriedade e segurança Empacotamento Outros itens de apresentação

15 Projeto e Desenvolvimento A fonte e adequação dos dados de entrada para os documentos devem ser confirmadas, e podem ser usadas ferramentas de documentação automatizadas Os documentos preparados p devem ser revistos e editados, conforme os padrões de documentação já citados Antes da emissão, eles devem ser aprovados pelo pessoal autorizado, que verificará sua adequação ao que for especificado Outro objetivo dessa fase é rever o plano de documentação, uma vez que já estejam disponíveis informações mais detalhadas d sobre os documentos

16 Projeto e Desenvolvimento A seqüência de atividades a serem realizadas durante a fase de projeto consiste em: Projetar a estrutura dos documentos Projetar o comportamento dinâmico dos documentos Incorporar os aspectos de hipermídia ao projeto Projetar a apresentação dos documentos Revisar o plano de produção e distribuição dos documentos

17 Produção O objetivo desta atividade é gerar os diferentes documentos de acordo com o projeto preliminar Cada documento deve ser elaborado com a informação produzida durante as diversas atividades do ciclo de vida do software, e servirá como ponto de partida para as demais atividades id d do projeto Durante esta fase, com base no conteúdo registrado em cada documento, a linguagem usada também deverá ser definida

18 Produção A produção e a distribuição dos documentos podem ser feitas em papel, por meio eletrônico, ou por qualquer outro meio Os documentos principais devem ser armazenados de acordo com os requisitos de retenção, segurança, manutenção e backup Os controles devem ser estabelecidos de acordo com o processo de gerência de configuração

19 Produção A seqüência das atividades a serem realizadas durante a fase de produção consiste em: Preparar o ambiente de produção Produzir e revisar os documentos Conceber a identificação dos documentos Liberar (e publicar) os documentos

20 Manutenção Nessa última atividade são desenvolvidas as tarefas relacionadas à Introdução controlada de modificações nos documentos Destruição dos documentos considerados obsoletos Armazenamento dos documentos em arquivos para que possam fazer parte do patrimônio documental da organização

21 Manutenção As alterações de documentos que estão sob controle da configuração devem ser gerenciadas de acordo com o processo de gerência de configuração. A seqüência de atividades a serem realizadas durante a fase de produção consiste em: Efetuar a manutenção dos documentos Armazenar ou eliminar documentos