Criação Documento Técnico (Release Notes)

Page edited by Urgel Weiller De Liz


- DOCUMENTO TÉCNICO (RELEASE NOTES)

Este documento tem como objetivo orientar o desenvolvedor a criar o Documento Técnico Versão Simplificada de acordo com as regras da Experiência #9.

TDN Oficial Linha Datasul: http://tdn.totvs.com/display/LDT/Linha Datasul Home

TDN Oficial Linha Logix: http://tdn.totvs.com/display/LLOG/Linha Logix Home

O Release Notes deverá ser criado direto no TDN, através do template Documento Técnico Versão Simplificada, dentro da estrutura de páginas:

- Linha Datasul / Linha Datasul Home / TOTVS + Release / Framework + Release
Ex.: Linha Datasul / Linha Datasul Home / TOTVS 12.1.7 / Framework - 12.1.7

- Linha Logix / Linha Logix Home / Release + Release / Tecnologia + Release
Ex.: Linha Logix / Linha Logix Home / Release 12.1.7 / Tecnologia 12.1.7

Importante:

- No SSIM na etapa “Elaborar Boletim Técnico”, no campo "Incidente" deve ser colado o link do TDN. O campo Solução, por ser obrigatório, pode ser preenchido com ".".
- O Documento de Evidência continua sendo necessário e nele deve ser colocado o texto do Release Notes e também o link do mesmo no TDN.



Para criar este documento:

1- Dentro da estrutura de pasta da linha referente ao chamado, clicar no botão Adicionar/ Página do Modelo.





2- Selecionar a template Documento Técnico – Versão Simplificada.





3- Inserir o Título da Página

Para Inovação: DT + Nome do Requisito, por exemplo: DT_LibreOffice.

Para Sustentação: Código do Chamado + Descrição, por exemplo: TSEDMV_DT_Geração_Arquivo_XLS

Importante:

- [CHAMADO]_DT_[Descrição] - Chamado em caixa alta e descrição capitalizada.
- Evitar o uso de preposições no nome do documento, pois o mesmo faz parte do link de acesso à página.



4- Preenchendo os campos do modelo

Importante:

- Sempre configurar texto na cor preta e não itálico para todo conteúdo da página. No template modelo o conteúdo atualmente está sendo preenchido com formato itálico e cor azul, devendo ser ajustado.
- Para a descrição do título da página pode-se utilizar preposições, sempre respeitando como padrão para o título da página o seguinte formato:
[CHAMADO] – [Descrição]
Chamado em caixa alta e descrição capitalizada.
- Ajustar label da coluna “Situação/Requisito” para “Situação”
- Ajustar label da coluna “Solução/Implementação” para “Solução”
- Ajustar label da coluna “Versões/Release” para “Release”
- Conversores e Parâmetros: Para chamados LOGIX temos situações de conversores (arquivos com extensão CNV e XML e as vezes programas de apoio para ajuste de base). Neste tópico deveremos listar:
NOME CONVERSOR – descrição
Objetivo: descrição resumida do objetivo do conversor
NOME PROGRAMA DE APOIO – descrição
Objetivo: descrição resumida do objetivo do programa de apoio
NOME DO ARQUIVO XML (METADADO) – descrição do conteúdo do XML indicando formulário ou tabela.
Instruções: Instruções para execução de conversor ou programa de apoio e importação de XML.
- Eliminando Linhas: Os campos/labels onde não tiver informações para registro, devem ser removidos da lista, usando o ícone REMOVE ROW, quando o cursor estiver posicionado numa das linhas da lista da template padrão conforme abaixo:



- Quando a eliminação da linha gerar diferença nas linhas destacadas, deve-se fazer o ajuste da cor de fundo para ficar um padrão de linhas destacadas de forma alternada(azul e branco), usando o botão CHANGE CELL COLOUR conforme abaixo:





5- Inserindo Labels (Tags)

- Clique no botão Label na parte inferior da tela



São labels obrigatórias:

- Segmento: framework e tecnologia
- Modulo: Ex.: seguranca, menu, controle_geral
- Versão/Release: Ex.: versao_12_1_7
- Objeto Manutenido: Ex.: sec000aa, bas_usuar_mestre, job001
- Código do Chamado: Ex.: TSAOB4

Importante:

- As labels são utilizadas pelo mecanismo de busca do TDN, por isso é importante inseri-las de forma correta.
- Não utilize caracteres especiais, nem letras com sinais gráficos como "ç", "ã", "ü".
- Use apenas letras minúsculas.
- Não acentue as palavras.
- Não insira espaços.
- Podem ser adicionadas labels além das padrões.



6- Clicar no botão salvar na parte inferior da tela, para finalizar o documento. O mesmo ficará com o status “Rascunho”.





7- Processo de Aprovação:

7.1 - Clicar no botão WorkFlow na parte superior direita da tela e passar o status para “Aguardando Aprovação”



7.2 - O responsável pelo Teste Unitário deverá analisar o documento e enviá-lo para o teste integrado passando para o status “Aguardando Revisão”



7.3 - Após aprovado o Release Notes o SQA passará o documento para o status “Aguardando Publicação” e após o Teste Sistêmico o documento se tornará público.



8- Palavras à serem evitadas:

Evitar​

Utilizar​

Apresenta a mensagem "xxx"


Apresenta uma mensagem informando que xxx


Baixa Performance


Dificuldade de desempenho


Código do programa


NUNCA


Corrigir


Alterar; solucionar


Errado


Incorreto


Erro


Inconsistência, Divergência


Nomes de clientes


NUNCA


Nomes de tabelas


NUNCA


Problema


Divergência


Termos técnicos


NUNCA

View Online · View Changes Online

Continue reading...