Skip to content

Template de Documento

Introdução

Este documento serve como um template padrão para a criação de toda a documentação do projeto Simblíssima. Ele fornece uma estrutura consistente que deve ser seguida para manter a organização e padronização dos documentos.

Metodologia

O template foi desenvolvido considerando as principais seções necessárias para documentar adequadamente os artefatos do projeto. A estrutura inclui: - Introdução: contextualização e objetivos - Metodologia: processo de desenvolvimento - Desenvolvimento: conteúdo principal dividido em versões - Conclusão: resultados e benefícios - Referências: fontes consultadas - Histórico de versões: controle de alterações

Como Utilizar o Template

Versão 1.0

1. Faça uma cópia deste arquivo 2. Renomeie o arquivo de acordo com o documento que será criado 3. Preencha o cabeçalho com id e título apropriados 4. Desenvolva o conteúdo mantendo a estrutura de seções 5. Para cada alteração significativa, crie uma nova subseção de versão 6. Mantenha a tabela de histórico de versões atualizada 7. Sempre utilize a formatação em justify nos parágrafos 8. Adicione referências relevantes seguindo o formato indicado

Conclusão

A utilização deste template permite manter um padrão consistente na documentação do projeto, facilitando a leitura, manutenção e rastreabilidade das informações. Além disso, fornece uma estrutura clara que ajuda os colaboradores a documentarem adequadamente seus artefatos.

Referências

SOMMERVILLE, I. Engenharia de Software. 9ª ed. São Paulo: Pearson Prentice Hall, 2011.

ISO/IEC/IEEE 12207:2017 - Systems and software engineering - Software life cycle processes

Autor(es)

Data Versão Descrição Autor(es)
04/06/2025 1.0 Criação do template de documento Bernardo Lobo, Bernardo Moreira, Guilherme Dias, Julia Curto e Michel de Melo