segunda-feira, 11 de setembro de 2017

Template Plano de Documentação


Plano de Documentação

Quando vamos escrever um documento técnico, seja ele um manual, uma especificação técnica ou um guia rápido, precisamos planejar o que este documento deve conter, ou seja, é necessário fazer um planejamento do documento para definirmos todo o escopo que o documento deve abranger, além de detalhes sobre recursos, prazos, requisitos só para citar alguns.

Neste post apresento um Plano de Documentação que pode ser utilizado antes do início da elaboração do documento técnico para alocar recursos e planejar a criação e manutenção do conteúdo técnico do documento. Além disto, forneço no final do post um Template do Plano de Documentação, que pode ser utilizado livremente como sugestão para a criação de seu próprio Plano de Documentação.

A elaboração do Plano de Documentação é tão importante quanto o próprio documento, porque ele vai auxiliar, facilitar e guiar a elaboração de seu documento durante toda a fase do projeto. Ele acaba sendo uma referência para toda a equipe com os detalhes para a elaboração do documento.

Um Plano de Documentação pode ser composto pelos tópicos:

Plano de Documentação
Tópicos Plano de Documentação
  • Propósito: Descreve para que serve o documento, qual o objetivo e o que se espera alcançar com o documento pronto.
  • Entregas: Descreve quais são os documentos que devem ser produzidos com detalhes dos responsáveis pelas várias fases e datas previstas de início e publicação.
  • Requisitos Gerais e Legais: Descreve quais são os requisitos gerais que o documento deve obedecer e os requisitos legais quando necessário como, por exemplo, normas que deve atender dependendo da área onde vai ser utilizado.
  • Audiência: Descreve quais são os tipos de pessoas que utilizarão o documento como, por exemplo, pessoas com conhecimento técnico do assunto, com algum conhecimento técnico, mas não conhecem o assunto propriamente dito, que são totalmente leigas ao assunto. Esta etapa é importante porque vai definir o tipo de terminologia e grau de dificuldade que o documento pode conter.
  • Premissas, Restrições e Dependências: Descreve o fato inicial que prevê a geração do documento, as dependências e restrições de utilização do documento.
  • Processo: Descreve os passos que devem ser executados na preparação do documento.
  • Prazos de Entrega: Determina os prazos de entrega de cada fase do documento.
  • Funções e Responsabilidades: Define as funções e responsabilidades de cada membro da equipe de comunicação técnica.
  • Recursos: Determina os recursos que serão utilizados na preparação do documento como, por exemplo, o software de editoração e publicação, ferramentas de desenho, uma versão do aplicativo (se software) ou um produto para utilizar durante a elaboração do documento, uma especificação de requisitos, ou um manual antigo.

Download Template Plano de Documentação

Conclusão


O Plano de Documentação é uma etapa importante no processo de elaboração de qualquer tipo de documento técnico, seja ele, um manual, um guia, uma apostila, um help online, etc., porque permite planejar e alocar recursos para criar ou manter o conteúdo técnico do projeto ou produto.

Referência