# Tipos de Documentos



# Estrutura de definição dos processos

<p class="callout info">Antes de iniciar a documentação de um processo, verifique se o mesmo já não está documentado, pois caso esteja, ao invés de criar um documento duplicado, pode-se analisar e complementar a documentação do processo tornando-a mais completa e confiável. </p>

#### **Uma definição de processo deve conter:** 

- Nome do processo
- Resumo do processo
- Envolvidos no processo
- Etapas do processo
- Ponto inicial do processo
- Ponto final do processo
- Resultado esperado

---

##### **Nome do processo** 

Inicialmente você deve utilizar ou criar um nome descritivo do que o processo em geral irá fazer, que tenha relação direta com o resultado final esperado.

Este nome será o nome utilizado no capítulo responsável pela documentação do processo em questão.

<p class="callout warning">Processos devem possuir responsabilidades únicas, ou seja, evite criar processos do tipo "Executar processo e verificar valor" ou "Gerar relatório e enviar e-mail"</p>

##### **Resumo do processo**

No resumo do processo, deve-se realizar uma descrição do que é o processo documentado, contextualizando a sua descrição à rotina que ele pertence (caso exista).

##### **Envolvidos no processo**

Todo processo tem pessoas, sistemas ou departamentos envolvidos, relatar quem são esses envolvidos ajuda para definir quem são os "responsáveis" diretamente naquele determinado processo.

##### **Etapas do processo**

Neste tópico, deve-se "quebrar" o processo em etapas, informando de maneira sucinta o que irá acontecer durante a execução do processo.

##### **Ponto inicial do processo**

Todo processo possui uma origem, então é importante analisar e descrever quem ou o que é o "gatilho" responsável pelo início da execução do processo documentado. Esse "gatilho" pode ser um clique, a conclusão de um processo anterior, um evento, etc.

##### **Ponto final do processo**

O ponto final do processo é a ultima ação cujo seu processo irá executar, para identificar este ponto é importante responder a seguinte pergunta: Após qual etapa, o processo pode ser considerado como concluído?

##### **Resultado esperado**

Todo processo tem um resultado, que se forem respeitadas todas as etapas, apresentará um resultado que era esperado. Neste tópico, também é importante relatar possíveis resultados incorretos e o que pode ter gerado tal resultado. Resultados estes, que serão documentados no "roteiro do processo".

<p class="callout info">Para um exemplo de definição de processo, consulte o capítulo "Revisão Colaborativa". \[linkar após conclusão da refatoração do processo\]</p>

# Roteiro de Etapas do Processo

O roteiro de etapas de um processo nada mais é do que a **descrição detalhada de cada uma das etapas que deverão ser seguidas** para sua conclusão.

O roteiro de etapas do processo deverá estar dentro de um capítulo responsável pela documentação do processo em questão e abaixo de sua definição.

#### **Um roteiro de etapas do processo deve conter:**

- Nome da etapa do processo que será detalhada no roteiro e relação com um processo <span style="text-decoration: underline;">[definido e detalhado previamente](https://wiki.supersoft.com.br/books/padrao-supersoft-de-documentacao/page/estrutura-de-definicao-dos-processos)</span>
- Resumo da etapa do processo
- Pré-requisitos necessários para a realização da etapa do processo
- Detalhamento dos passos necessários para execução da etapa em questão (ponto inicial e ponto final)
- Resultado esperado

---

##### **Nome da etapa do processo que será feito o roteiro**

O nome da etapa do processo deve ser condizente com alguma das <span style="text-decoration: underline;">[etapas do processo](https://wiki.supersoft.com.br/books/padrao-supersoft-de-documentacao/page/estrutura-de-definicao-dos-processos#bkmrk-extraindo-e-dividind)</span> já descritas na <span style="text-decoration: underline;">[estrutura de definição do processo](https://wiki.supersoft.com.br/books/padrao-supersoft-de-documentacao/page/estrutura-de-definicao-dos-processos)</span>. Assim qualquer usuário ao ler o nome/título da página saberá que a mesma é referente à uma etapa específica do processo.

---

##### **Resumo da etapa do processo**

No resumo da etapa do processo, deve-se realizar uma descrição do que é especificamente essa etapa, contextualizando a sua descrição ao processo que ela pertence.

---

##### **Pré-requisitos necessários para realização da etapa do processo**

Enumerar todos os processos ou etapas que precisam ser realizadas antes de dar início à execução da etapa em questão, ou seja, listar quais são as condições para que a etapa possa ser executada. <span style="text-decoration: underline;">[Dentro da definição de um processo](https://wiki.supersoft.com.br/books/padrao-supersoft-de-documentacao/page/estrutura-de-definicao-dos-processos)</span> existem diversas <span style="text-decoration: underline;">[etapas](https://wiki.supersoft.com.br/link/196#bkmrk-extraindo-e-dividind)</span> que precisam ser realizadas, essas etapas normalmente dependem de uma sequência de execução para que possam ser realizadas. A hierarquia dessa sequência são os pré-requisitos para realização das etapas seguintes e assim por diante.

---

##### **Detalhar especificamente a etapa do processo em questão**

Nesse tópico devem ser detalhados todos os processos necessários para a realização da etapa em questão, com o máximo de detalhes possíveis, imagens, instruções e dicas que auxiliem na execução da mesma. Obrigatoriamente uma etapa tem um ponto de início, ou seja, a partir de que momento essa etapa deve ser realizada e um ponto final, que indica quando a etapa pode ser considerada como concluída.

---

##### **Resultado esperado**

Toda etapa do processo tem um resultado, positivo ou negativo, onde se seguidos todos os passos citados no detalhamento da etapa, obteremos o resultado esperado.

---

<p class="callout info">Para um exemplo de definição de etapas de um processo, consulte o capítulo "Processo: Aguardando Revisão". \[linkar após conclusão da refatoração do processo\]</p>

# Informações Adicionais do Processo

#### **Introdução**

Arquivos desse tipo são utilizados para documentar **informações adicionais de processos**, que embora não façam parte da sua definição ou do seu roteiro, **merecem ser mencionadas** para melhor aproveitamento ou desempenho do colaborador que irá executar esse processo posteriormente.

Por se tratar de um tipo de documento que **pode ter vários formatos ou objetivos**, nesta página estarão descritas algumas condições para **validar se as informações candidatas à documentação** são realmente informações adicionais do processo e **devem possuir uma página desse tipo, ou devem estar presentes em outro tipo de documento, ou até que não necessitem ser documentadas.**

#### **Validando as informações candidatas**

Antes de iniciar propriamente a construção do documento, deve-se realizar as seguintes perguntas:

- Essa informação faz parte da **definição** do processo?
- Essa informação faz parte do **roteiro** do processo?
- Essa informação é específica de um **exemplo** do processo?

Caso a resposta seja "**sim**" para alguma das perguntas acima, então talvez essas informações não devem estar em um documento adicional, e sim **em outro tipo de documento**.

Caso contrário, então avançaremos na validação das informações candidatas.

- Qual é o **objetivo** de documentar essas informações?

Apesar da resposta dessa pergunta ser subjetiva e muito abrangente, o objetivo final de toda e qualquer documentação é: **auxiliar outra pessoa**, que posteriormente irá realizar o mesmo processo **à avançar sobre quaisquer impasses que possam surgir durante o processo**. Neste caso, podemos utilizar a metáfora dos anões sobre ombros de gigantes, onde expressa o significado "**descobrir a verdade a partir das descobertas anteriores**".

Caso o objetivo de documentar as informações adicionais seja o objetivo descrito acima, então essa informação merece ser documentada, podendo assumir o formato de (Dicas sobre o processo; Atalhos; Materiais complementares; etc)