Nome do processo

Começar com a palavra "Como" e seguir com um verbo e o substantivo, ex: "Como criar template"

Propósito

Escrever qual a função do processo e resumidamente listar qual ações ele descreve. Ex:

Criar um template ou um exemplo padrão para ser usado ao se criar um novo processo.

Pré-requisitos

Listar todos os pré-requisitos para executar as ações descritas para esse processo. Ex:

Conta GitHub ativa
Acesso à organização e ao repositório da documentação com uma das seguintes permissões:
- Owner
- Admin
- Membro com permissões específicas para criar processos

Processo

Descrição passo a passo para se executar a ação descrita pelo processo. Procure manter o processo conciso, sem expandir muito os tópicos. Entre 8 e 10 passos é o suficiente para qualquer processo, se for preciso muitos passos para executar o processo, considere criar um novo processo para os passos mais complexos. Ex:

Clonar o repositório da documentação no GitHub da organização

Abrir um prompt de comando (cmd, PowerShell, WSL);
Navegar até o diretório onde se deseja clonar o repositório localmente;

Executar o comando:

git clone git@github.com:bdbrid/documentacao.git

Criar uma branch para o novo template e abrir o projeto

No prompt de comando navegue até o diretório do projeto e execute:
```
git checkout -b novo-template
```
Abra o projeto no editor de texto ou IDE de sua preferência;

Criar o arquivo do novo template

Navegar até o diretório onde deseja criar o template;
Criar um novo arquivo com a extensão ".md";
Editar o arquivo usando sintaxe Markdown;

Fazer Commit e Push

No prompt de comando, navegue até o diretório do projeto;
Execute o comando:
```
git commit -m "Criado o template"
```
Envie as alterações para o repositório remoto usando os seguintes comandos:
```
git fetch origin
```
```
git push -u origin
```

Fazer Pull Request

Acesse o repositório no GitHub da organização;
Escolha a branch que você criou ("novo-template") e clique em Compare and pull request
Preencha o título e a descrição para seu Pull Request;
Clique em Create pull request;

Critérios de Sucesso

Especificar como saber se o processo foi executado com sucesso. Ex:

Template criado e enviado para revisão e inserção à página de documentação

FAQ

Listar possíveis dúvidas que podem surgir quando o procedimento for seguido. Ex:

O que fazer se o botão `Compare e pull request` não estiver visível?

Verifique suas permissões na organização. Contate um administrador se necessário.

Posso alterar os arquivos após fazer o Pull Request?

Sim, desde que seja alterado antes que as mudanças sofram o Merge com a branch principal.