Processo de documentação automática - Jira x TDN

Até então, o processo de documentação no TDN era realizado manualmente, sendo necessário que fosse criada a página no TDN, preenchidos os campos necessários e depois de salva esta documentação, realizado o vínculo da URL do TDN com o campo Documento Técnico (URL) na Issue do Jira:

A partir de agora, os documentos serão criados no TDN e vinculados ás respectivas Issues no Jira automaticamente. Bastando que sejam preenchidos alguns poucos campos quando solicitado.

Abaixo, maiores detalhes do novo processo.

Utilizando uma Issue (manutenção) que criei apenas para este teste e documentação, fui realizando os passos normalmente no Jira. Simulando um processo normal, deixei a Issue com status “EM DESENVOLVIMENTO”.

O próximo passo, seria finalizar a CODIFICAÇÃO. Note que o botão “Desenvolvimento Concluído” foi alterado, sendo incluído a observação “(Com Doc)”, ao parar o ponteiro do mouse sobre este botão:

Agora, ao clicar neste botão, indicando que a CODIFICAÇÃO foi concluída, ou arrastar a Issue utilizando o Board, será exibida uma janela como esta, onde será necessário preencher os campos indicados em vermelho e depois, no final desta janela, clicar no botão que confirma o processo, “Desenvolvimento Concluído (Com Doc)”:

Preenchidos os campos, conforme imagem abaixo, basta clicar no botão “Desenvolvimento Concluído(Com Doc)”:

Estando tudo correto, será exibida uma mensagem como esta no canto superior direito do Jira:

Abaixo, um exemplo de URL vinculado á Issue, referente a um documento gerado automaticamente no TDN:

Na imagem a seguir, um Print do próprio documento gerado automaticamente, na própria página TDN:

O restante do processo deverá seguir normalmente com a Issue.

Quando a Issue chegar no status ‘Em documentação’, os Testers/Q.A´s deverão fazer a verificação das informações no documento, os ajustes, caso necessário, e a Aprovação do documento.

Para os QA´s ou Tester´s que vão criar as pastas Pai no TDN.

É necessário que as pastas criadas no TDN, no nosso Space, tenham o rótulo (label) “documento_tecnico”.

Para isso, acessar a pasta e clicar no ícone de rótulo, conforme imagem abaixo:

Na janela que se abrirá, preencher o conteúdo “documento_tecnico” e clicar em ‘Adicionar’ e depois em ‘Fechar’:

Agora, note que o rótulo foi incluído nesta pasta:

Desta forma, o robô que gera a documentação automática entende que pode buscar estas pastas para que sejam utilizadas no momento de preencher o campo “Página Pai TDN”.

É interessante que esses rótulos sejam retirados depois que a release for fechada, para que não fiquem disponíveis possibilidades incorretas de serem utilizadas no momento do preenchimento do campo, conforme exemplo abaixo: