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 da definição do mesmo.
Um roteiro de etapas do processo deve conter:
- Nome da etapa do processo que será detalhada no roteiro e relação com um processo definido e detalhado previamente
- Resumo da etapa do processo
- Pré-requisitos necessários para a realização da etapa do processo
- Detalhar especificamente alguma das etapas do processo em questão
- Ponto inicial da etapa
- Ponto final da etapa
- Resultado esperado
Nome da etapa do processo que será feito o roteiro
O nome da etapa do processo deve ser condizente com alguma das etapas do processo já descritas na estrutura de definição do processo. 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. Dentro da definição de um processo existem diversas etapas 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 alguma das etapas do processo em questão
Ponto inicial da etapa
Ponto final da etapa
Resultado esperado
Por exemplo, dentro do processo de liberação e fechamento do branch de versões existe a etapa de atualização dos arquivos "config.ini".