Engenharia de Software

Documentação (resumo)

Os objetivos deste capítulo são descrever os diferentes tipos de documentação que podem ser produzidos para grandes sistemas de software e apresentar as diretrizes para produção de documentos de alta qualidade.

Grandes projetos de desenvolvimento de software, independentemente da aplicação, geram uma vasta quantidade de documentação associada. Uma alta proporção dos custos do processo de software, especialmente para sistemas regulados, está envolvida na produção desses documentos. Além disto, erros de documentação e omissões podem gerar erros de usuários finais e, consequentemente, falhas de sistema com custos e interrupções associados. gerentes e engenheiros de software devem dar bastante atenção para a documentação e seus custos associados. Os documentos associados com o projeto de software e o sistema em desenvolvimento têm uma série de requisitos: 1. Agir como um meio de comunicação entre membros da equipe de desenvolvimento. 2. Ser um repositório de informações a serem usadas pelos engenheiros de manutenção. 3. Oferecer informações aos gerentes para ajudar a planejar, criar um orçamento e programar o processo 4. Alguns dos documentos devem contar aos usuários como usar e administrar o sistema. 5. Os engenheiros de software são geralmente responsáveis pela produção de grande parte dessa documentação, ainda que escritores técnicos profissionais possam oferecer assistência.

Para grandes projetos, em geral, a documentação começa a ser gerada bem antes do processo de desenvolvimento começar. Uma proposta para desenvolver o sistema pode ser produzida em resposta à solicitação para apresentação de propostas por um cliente externo ou em resposta a outros documentos de estratégia de negócios.

O conjunto de documentos que você tem de produzir para qualquer sistema depende do contrato com o cliente do sistema, o tipo de sistema em desenvolvimento e sua expectativa de vida útil, a cultura e o tamanho da companhia que