Modelo de Documentação Padrão

Segue modelo de documentação inicial de projeto. Cada item pode estar presente de acordo com necessidades do projeto. Cada item e seção deverão ser avaliados se são apropriados ao projeto em cada fase de seu desenvolvimento. Se muito extensos, alguns itens deverão ser realocados em páginas separadas.

Título do Projeto

Frase de impacto que ilustre a importância do projeto (desenvolvimento, uso/aplicações).

(Inserir aqui foto que ilustre o projeto.)

Descrição do Projeto

Inicia-se uma descrição breve do projeto, de um ou dois parágrafos. Usos e aplicações1.


Principais Características

  • Características listadas vão aqui;
  • Aqui vai a outra característica do projeto;
  • Mais uma propriedade do projeto.

Histórico

Data Evento
06/01/15 Início da discussão sobre padronização
07/01/15 Criação do esboço de modelo

Próximos Passos


Documentação

Desenvolvimento

Descrição completa do desenvolvimento e produção do projeto. Insira links para repositórios, esquemáticos, códigos-fonte, procurando inserir os arquivos editáveis originais2.

Uso

Descrição de como se dá a utilização de produto. Instruções de utilização, configuração e operação.

Ensino

Oficinas e tutoriais direcionados para aplicação em grupos por instrutores.
Observação: É produtivo que seja adicionada uma frase ao final de cada tutorial que incentivo o uso dos fóruns como ambiente de discussão, exemplo:
"Dúvidas e sugestão são bem recebidas no fórum." Sendo a palavra "fórum" um hiperlink para a página do fórum do projeto.


Contatos

  • Links externos e outros contatos.
  • Lista de e-mails: lista [arroba] doprojeto.com
  • Gerente do projeto: gerente [arroba] doprojeto.com
  • Outro contribuidor: outro [arroba] contribuidor.com

Referências

1 Referência numerada de acordo com aparição no texto.

2 Flavio Depaoli, et al. 2015. Modelo de Documentação Padrão. [ONLINE] Disponível em: http://cta.if.ufrgs.br/projects/suporte-cta/wiki/Modelo_de_Documenta%C3%A7%C3%A3o_Padr%C3%A3o. [Acesso em 07 de Janeiro de 2015].


Este esboço de projeto é, por sua natureza, domínio público. Autores: Flávio Depaoli, Jan Luc Tavares, Renan Bohrer, Béuren Bechlin, Lucas Leal, Rafaela Wetternick.