Arquivo de Documentação

Arquivo de documentação
Caminho	Programa/Arquivo de documentação
Tecla de Atalho	Nenhuma
Botão

Todo projeto possui um arquivo do tipo texto (ASCII) associado ao mesmo. Este arquivo tem por finalidade disponibilizar uma base para documentação geral do projeto e principalmente para controle de versões do programa associado. Quando um projeto é criado, este arquivo é inicializado com um formato básico, conforme indicado abaixo:

=======================================================================
 Documentação de Projeto e Controle de Alterações
=======================================================================

Empresa     :
Projeto     :
Cliente     :
Analista    :
Controlador :               Firmware: x.x.xx
Ambiente    :               Versão: x.x.xx

=======================================================================

============================
1. Controle de Alterações
============================

Obs:  Use B- para indicar correção de bugs
                F- para indicar nova funcionalidade
          I- para indicar uma melhoria de funcionalidade

1. Controle de Alterações
===========================

---------------------------------------------------------------------
Versão: 1.00 Data: dd/mmm/yyyy    Resp.:

Compatibilidade: integral

Descrição das Alterações:

F- Versão original

Data: dd/mm/2010  Resp.:
F- digite aqui as novas funcionalidades, melhorias e correções de bugs
   realizados nesta versão. Inicie cada novo paragrafo com uma das
   letras indicadas na tabela acima.


2. Documentação de Projeto
============================

2.1 - Descrição funcional
-------------------------

2.2 - Requisitos de Entrada
---------------------------

2.3 - Caracteristicas de Saída
------------------------------

2.4 - Testes Aplicados
----------------------

2.5 - Testes de Validação
-------------------------

Naturalmente, este formato apresentado pode ser alterado, estando o usuário livre para adaptá-lo para uma formatação que mais lhe convier. Caso o usuário possua um outro padrão para este arquivo, pode alterar o modelo do mesmo editando o arquivo DocBase0416.txt (Português) ou DocBase0409.txt (Inglês), que se encontram na pasta de instalação do software. Desta forma, sempre que for criado um novo projeto, o mesmo será inicializado com uma cópia deste arquivo de modelo.

Dica

Documentação do projeto implementado é fundamental para manutenção do mesmo. Portanto, tenha certeza que todo tempo despendido em uma boa documentação será economizado posteriormente quando você necessitar modificar o programa.