Skip to main content

Definindo escopo do documento

Considerações Inicais

A definição do escopo do documento é feita através dos seguintes fatores:

  • Livro/capítulo que ele está localizado
  • Título do documento
  • Público alvo
  • Modelo do documento (definição, roteiro, exemplo, dicas, etc)

 

Livro/capítulo que ele está localizado

Ao iniciarmos o processo de documentação, devemos levar em consideração o livro ou capítulo em que o documento estará localizado, de maneira que a página após criada faça sentido no contexto inserido. As estruturas de livros e capítulos devem seguir uma "história", de modo que as etapas iniciais do processo estejam posicionadas antes da etapa principal ou finalização do processo.

Por exemplo, ao adicionar um documento falando sobre um pré-requisito de algum processo, é interessante que este documentado seja ordenado de modo que seja a primeira página do livro ou capítulo que está contido.contido. E caso o documento esteja definido como "pré-requisito", não é interessante que sejam documentadas etapas do processo principal nesta página,gina, mas sim, apenas as etapas que estão antes do processo descrito no livro/capítulo.

Outro exemplo, é um documento do tipo roteiro/guia/passo-a-passo de como realizar algum processo. Neste tipo de documento, não é interessante que estejam definições, ou explicações de como o processo deve funcionar.funcionar. Em documentos desse tipo, deve ser exemplificado um caso do processo,processo, documentando desde a etapa inicial ou pré-requisito (caso exista), até a conclusão do processo.

Título do documento

 

Público alvo

 

Modelo do documento

Definição de processo

 

Roteiro de processo

 

Exemplo de processo

 

Dicas sobre o processo