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. E caso o documento esteja definido como "pré-requisito", não é interessante que sejam documentadas etapas do processo principal nesta página, mas sim, apenas as etapas que estão antes do processo descrito no livro/capítulo.
Em uma situação onde o documento em questão é uma definição de processo, a página deve conter os itens abordados no processo, suas respectivas explicações e como o processo deve se comportar, informando o que cada etapa significa, o que deve ser levado em consideração, o motivo de tal etapa, etc. Essas definições devem ser claras e precisas, para que sirva de base para a construção de outros documentos à partir daquele. Como por exemplo, a construção de exemplos ou guias sobre o processo definido.
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. Em documentos desse tipo, devedevem ser exemplificadodetalhadas umas casoetapas do processo e as questões pertinentes à cada passo, 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