# Definindo escopo do documento #### **Considerações Inicias** A definição do escopo do documento é feita através dos seguintes fatores: - **[Livro/capítulo que ele está localizado;](#bkmrk-livro%2Fcap%E3%ADtulo-que-el-0)** - [**Título da página**](#bkmrk-t%E3%ADtulo-do-documento)**;** - [**Público alvo**](#bkmrk-p%E3%BAblico-alvo)**;** - [Tipo de documento](https://wiki.supersoft.com.br/books/padrao-supersoft-de-documentacao/chapter/tipos-de-documentos); --- #### **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 documento 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, **devem ser detalhadas as etapas 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 da página** Em qualquer página adicionada, é importante que o título seja fiel ao conteúdo descrito no documento. Isso faz com que a biblioteca tenha um bom nível de confiabilidade, fazendo com que, quando outro usuário buscar por alguma informação, os títulos das páginas possam ser um bom filtro para identificar onde localizar a informação desejada.

Não é interessante que em uma página onde o título é "**Instalação da ferramenta X**", estejam descritas informações de como utilizar a ferramenta ou o motivo de utilizar tal ferramenta.

No caso acima citado, seria interessante possuir um capítulo contendo duas ou três páginas para o conteúdo, dividindo da seguinte maneira: **Capítulo: Ferramenta X Páginas: Apresentação da ferramenta; Instalação e Configuração; Dicas e atalhos;**

--- #### **Público alvo** Na criação de documentos, outro tópico de extrema relevância é o público à que o documento está destinado. Por se tratar de uma plataforma onde diversos setores possuem acesso, e dentro desses setores podem existir desde **pessoas que não conhecem o processo documentado** à **pessoas que dominam completamente o mesmo processo**. Deve-se levar em consideração que todos, à partir do processo documentado, consigam entender ou pelo menos assimilar do que se trata. Entre os objetivos da documentação, um deles é a possibilidade de **iniciar novos colaboradores aos processos (sejam internos ou do sistema)**, para que formem um entendimento das rotinas e de como elas devem funcionar. Por isso, ao criar um documento, não poupe detalhes. Ao avançar na documentação, **caso observe que o conteúdo está muito denso** (ou seja, possui um nível de detalhamento excessivamente alto). Verifique a possibilidade de **dividir o documento em duas ou mais páginas** para que fique mais fácil a "digestão" das informações pelas pessoas que consultarão o documento posteriormente. Podendo criar **uma página com informações mais básicas do processo** e **outra com uma visão mais ampla e generalizada**.

Para isso, utilize de [callouts](https://wiki.supersoft.com.br/link/144#bkmrk-callouts-s%E3%A3o-op%E3%A7%E3%B5es-p) informativas com descrições do tipo "Caso você não saiba como realizar tal ação, clique aqui" ou "Para maiores informações sobre determinada etapa, consulte tal página"