Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.
Documentação de Software     Simone Vasconcelos                           1
ContextoQualquer software deve ter uma quantidaderazoável de documentação.!   Documentos de trabalho.!   Manuais de usuári...
Usos da DocumentaçãoMeio de comunicação entre os membros deum grupo de desenvolvimento;Informações para as pessoas que ven...
Tipos de DocumentaçãoDocumentação do processo!   É produzida para que o processo de    desenvolvimento do software seja ad...
Documentação do Processo -       Categorias Planos, estimativas, e cronogramas !   Produzidos por gerentes !   Usados para...
Documentação do Processo -       Categorias Memorandos, comunicações, mensagens eletrônicas  !   Registram as comunicações...
Documentação do ProdutoDescreve o software produzido.Tem vida longa e deve estar sempreatualizada em relação ao código.Div...
Documentação do UsuárioDeve levar em conta os diversos tipos deusuáriosÉ importante distinguir entre os váriosusuários. Ex...
Documentação do UsuárioDescrição funcional do sistema!   Requisitos gerais do sistema!   Serviços fornecidos por eleManual...
Documentação do UsuárioManual de referência!   Descreve as facilidades do sistema e seu uso!   Fornece uma lista das mensa...
Documentação do UsuárioManual do administrador do sistema.!   Informações    relevantes   para   uma    boa    administraç...
Documentação do SistemaDescreve a implementação do sistema,desde a especificação dos requisitos até oplano de testes.É imp...
Documentação do SistemaDocumento de requisitosDescrição da arquitetura do sistemaDescrição da arquitetura de cada um dospr...
Documentação do CódigoPode ser extremamente útil para melhorar(facilitar) o entendimento dos programas:!   Escolha de nome...
Escolha de NomesOs nomes devem ser significativos emrelação ao que eles representam.Identificadores maiores melhoram acomp...
Organização VisualManeira como o código aparece na tela docomputador ou em uma listagem.Os padrões de boa codificação mais...
ComentáriosDevem ser usados para explicar o que osoftware faz, ao invés de como ele faz.Duas formas de comentários são mai...
Comentários em Forma de       PrólogoAparecem no início de cada módulo.Formato:!   Declaração de propósitos;!   Descrição ...
Comentários em Forma de       Prólogo!   Histórico do seu desenvolvimento     ! O nome do autor.     ! A data em que foi c...
Comentários FuncionaisEncontram-se embutidos no código fonte.Descrevem as funções de processamento.Devem fornecer algo a m...
Qualidade dos DocumentosA    qualidade     da    documentação         é   tãoimportante quanto a qualidade do código.Aspec...
Padrão do Processo de       DocumentaçãoProcedimentos de desenvolvimento:!   Ferramentas;!   Procedimentos de qualidade.Fl...
Padrão de DocumentaçãoAplicam-se a todos os documentos (deum projeto)!   Identificação;!   Estrutura;!   Apresentação;!   ...
Estilo de EscritaO estilo do escritor é crucial para aqualidade da documentação.Diretrizes:! Correção gramatical;! Sentenç...
Pontos PrincipaisDocumentação tem vários usos técnicos egerenciais.Documentação pode ser de processo ou deproduto.Qualidad...
Upcoming SlideShare
Loading in …5
×

Documentos de software

  • Login to see the comments

Documentos de software

  1. 1. Documentação de Software Simone Vasconcelos 1
  2. 2. ContextoQualquer software deve ter uma quantidaderazoável de documentação.! Documentos de trabalho.! Manuais de usuário produzidos profissionalmente.Em geral, a maioria destes documentos éproduzida por engenheiros de software.Uma parte considerável dos custos de umprojeto pode ser gasta com documentação. 2
  3. 3. Usos da DocumentaçãoMeio de comunicação entre os membros deum grupo de desenvolvimento;Informações para as pessoas que venham afazer manutenção no sistema;Informações à gerência de modo a ajudar aplanejar, fazer o orçamento e o cronograma;Informações para ensinar aos usuários comoutilizar e administrar o sistema. 3
  4. 4. Tipos de DocumentaçãoDocumentação do processo! É produzida para que o processo de desenvolvimento do software seja administrável! Registram os processos de desenvolvimento e manutenção do softwareDocumentação do produto! Descreve o software que está sendo desenvolvido! É muito utilizada depois que o sistema é implementado, mas é essencial também para a administração do processo de desenvolvimento 4
  5. 5. Documentação do Processo - Categorias Planos, estimativas, e cronogramas ! Produzidos por gerentes ! Usados para prever e controlar o processo. Relatórios ! Descrevem como os recursos foram utilizados durante o desenvolvimento do software Padrões ! Estabelecem como o processo deve ser implementado ! Podem ser organizacionais, nacionais, ou internacionais 5
  6. 6. Documentação do Processo - Categorias Memorandos, comunicações, mensagens eletrônicas ! Registram as comunicações entre gerentes e engenheiros de software Documentos técnicos de trabalho ! Registram as idéias e pensamentos dos engenheiros de software. ! Descrevem estratégias de implementação. ! Registram problemas já identificados. ! Especificam as razões para as decisões de projeto. 6
  7. 7. Documentação do ProdutoDescreve o software produzido.Tem vida longa e deve estar sempreatualizada em relação ao código.Divide-se em:! Documentação do usuário.! Documentação do sistema. 7
  8. 8. Documentação do UsuárioDeve levar em conta os diversos tipos deusuáriosÉ importante distinguir entre os váriosusuários. Exemplo:! Usuários finais ! Usam o software para auxiliá-los em alguma tarefa ! Não estão interessados em detalhes técnicos ou administrativos.! Administradores do sistema ! Responsáveis pela administração do software ! Ex: operadores, gerentes de rede, etc. 8
  9. 9. Documentação do UsuárioDescrição funcional do sistema! Requisitos gerais do sistema! Serviços fornecidos por eleManual de introdução! Apresenta uma introdução informal do sistema e descreve seu uso normal! Deve explicar como começar a usar o sistema e como os usuários podem utilizar as facilidades oferecidas pelo sistema 9
  10. 10. Documentação do UsuárioManual de referência! Descreve as facilidades do sistema e seu uso! Fornece uma lista das mensagens de erro e descreve como agir quando os erros ocorrerem! Deve ser completo e técnicas de descrição formal podem ser utilizadasDocumento de instalação! Descreve como instalar o sistema! Especifica a plataforma mínima necessária à sua instalação 10
  11. 11. Documentação do UsuárioManual do administrador do sistema.! Informações relevantes para uma boa administração do sistemaManual de referência rápida do sistema.! Informações concisas das principais funções do sistema e como utilizá-las! Mensagens de erros mais comunsAjuda on-line 11
  12. 12. Documentação do SistemaDescreve a implementação do sistema,desde a especificação dos requisitos até oplano de testes.É importante que seja estruturada comoverviews levando a especificações maisdetalhadas e formais de cada aspecto dosistema. 12
  13. 13. Documentação do SistemaDocumento de requisitosDescrição da arquitetura do sistemaDescrição da arquitetura de cada um dosprogramasListagens do código fonte dos programasDocumentos de validação, descrevendo! Como cada programa é validado! Como estas informações se relacionam com os requisitosGuia de manutenção! Problemas já identificados! Partes do sistema que são dependentes do hardware 13 e software utilizados
  14. 14. Documentação do CódigoPode ser extremamente útil para melhorar(facilitar) o entendimento dos programas:! Escolha de nomes;! Organização visual;! Comentários. 14
  15. 15. Escolha de NomesOs nomes devem ser significativos emrelação ao que eles representam.Identificadores maiores melhoram acompreensão dos programas, mesmoem programas pequenos.Identificadores grandes demaisdificultam sua digitação e podem setornar uma fonte de erros. 15
  16. 16. Organização VisualManeira como o código aparece na tela docomputador ou em uma listagem.Os padrões de boa codificação mais aceitosincluem:! Um único comando por linha;! Espaçamento entre os componentes dos comandos;! Indentação. 16
  17. 17. ComentáriosDevem ser usados para explicar o que osoftware faz, ao invés de como ele faz.Duas formas de comentários são maiscomuns:! Comentários em forma de prólogo;! Comentários funcionais. 17
  18. 18. Comentários em Forma de PrólogoAparecem no início de cada módulo.Formato:! Declaração de propósitos;! Descrição da interface com outros módulos: ! Forma de uso; ! Quais os módulos subordinados; ! etc.! Pequena descrição dos dados, variáveis, limitações de uso, e quaisquer outras informações que sejam importantes. 18
  19. 19. Comentários em Forma de Prólogo! Histórico do seu desenvolvimento ! O nome do autor. ! A data em que foi criado. ! Para cada uma das modificações feitas no módulo: ! O nome do revisor; ! A data de alteração; ! Uma descrição da alteração. 19
  20. 20. Comentários FuncionaisEncontram-se embutidos no código fonte.Descrevem as funções de processamento.Devem fornecer algo a mais do quesimplesmente parafrasear o código.Bons comentários:! Descrevem blocos de código ao invés de comentar cada uma das linhas.! Usam linhas em branco e indentação para que o texto dos comentários seja facilmente identificável.! São corretos. 20
  21. 21. Qualidade dos DocumentosA qualidade da documentação é tãoimportante quanto a qualidade do código.Aspectos importantes para se conseguirproduzir bons documentos incluem:! Planejamento (ou projeto) dos documentos;! A existência de padrões a serem seguidos;! Procedimentos de garantia de qualidade. 21
  22. 22. Padrão do Processo de DocumentaçãoProcedimentos de desenvolvimento:! Ferramentas;! Procedimentos de qualidade.Flexíveis para lidar com todos os tiposde documentos; 22
  23. 23. Padrão de DocumentaçãoAplicam-se a todos os documentos (deum projeto)! Identificação;! Estrutura;! Apresentação;! Indicação de mudanças. 23
  24. 24. Estilo de EscritaO estilo do escritor é crucial para aqualidade da documentação.Diretrizes:! Correção gramatical;! Sentenças e parágrafos curtos;! Concisão;! Precisão;! Repetição de conceitos complexos;! Seções, sub-seções, e listas. 24
  25. 25. Pontos PrincipaisDocumentação tem vários usos técnicos egerenciais.Documentação pode ser de processo ou deproduto.Qualidade da documentação depende de:! Planejamento;! Padronização;! Medidas de qualidade;! Estilo de escrita. 25

×