Desenvolvendo Boletim Técnico Documentação Porto Alegre, Maio 2014.
Transcript of Desenvolvendo Boletim Técnico Documentação Porto Alegre, Maio 2014.
Desenvolvendo Boletim Técnico
Documentação Porto Alegre, Maio 2014
HOJE FALAREMOS SOBRE1. Etapas do processo de desenvolvimento do artefato Boletim
Técnico de acordo com a MDP TOTVS.
• Atentar à atualizações de “template” de Boletim técnico disponível em:http://www.tdn.totvs.com/pages/releaseview.action?pageId=47908280 • O analista/desenvolvedor pode acrescentar ou excluir informações desde que não afetem o conteúdo (por
exemplo, os testes da equipe de SQA).• Todos os modelos do padrão que não forem utilizados como tabelas, parâmetros não podem ser removidos,
você deve inserir o texto Não se aplica.
Informações Iniciais
• As informações orientativas que estão no corpo no documento também devem ser removidas.
Informações Iniciais
Cabeçalho
Um BT contém em seu cabeçalho as seguintes informações
• Título do Boletim: É o resumo objetivo do boletim em única sentença e não
deve possuir caracteres especiais. Exe.: Novo campo X na rotina Y.
• Seja objetivo, mas passe todas as informações necessárias.
• Evite palavras negativas que remetam à erros no sistema.
• Exe.: Correção de um erro x Alteração para adequar a necessidade.
• Em caso de alterações extensas, estruture a introdução em tópicos e sub
tópicos.
• Informe os nomes das rotinas, tais como aparecem no menu para o usuário
do sistema.
• Exe.: Módulo Higienização/Programas de limpeza.
Cabeçalho
Um BT contém em seu cabeçalho as seguintes informações
• Utilize a caixa de texto Importante apenas para boletins de aplicação de
Atualizações. Em caso contrário ela deve ser removida.
Introdução
Resume em que consiste o BT.
• Utilize como base as seguintes perguntas:• O que foi feito? • Qual o comportamento anterior? • O que foi alterado?• Onde? • Em qual rotina? • Com qual objetivo?• Qual será sua utilização?• Qual seu benefício? • Como influencia as demais rotinas/processos?
Procedimento para Implementação
• A seção Procedimentos de Implementação engloba:• Procedimentos prévios.• Pacote de atualização.• Versão utilizada.
• Descreva como a atualização será aplicada.• Procedimentos prévios - explique
se há algum procedimento a ser executado antes de aplicar a atualização.
Atualização de Update Compatibilizador
Informe nesse tópico todas as alterações que foram realizadas, como por exemplo:• Criação ou Alteração de Campos em tabelas.• Criação ou Alteração de consultas SQL.• Criação ou Alteração de arquivos.• Criação ou Alteração de permissão de acesso.• Lembre-se: o campo versão na opção Arquivos,
diz respeito a versão no TFS (changeset).
Procedimento para Configuração
Neste tópico, são descritas todas as configurações que devem ser feitas manualmente pelo usuário do sistema. Exemplo:• Criação e configuração de parâmetros.• O modelo de boletim técnico traz alguns textos padronizados que
facilitam a construção dessa documentação para os analistas.• Mantenha o texto que corresponda entre “Criação ou Alteração”
“Criação ou Configuração” e apague a não utilizada.• Lembre-se de que os procedimentos para configuração não
precisam ser descritos um a um.• Não se esqueça de informar o nome do parâmetro que foi
atualizado ou criado.• As tabelas disponibilizadas são apenas modelos. Novos formatos
podem ser criados de acordo com a necessidade.
Procedimento para Utilização
Indique em tópicos todas as etapas necessárias que o usuário deve seguir para chegar ao resultado esperado.• Especifique o módulo e a rotina que o usuário deve acessar.• Informe como chegar à rotina envolvida no processo que se quer demonstrar.• Exemplo: Centro Cirúrgico/ Cadastros/ Equipamentos.
• Descreva os campos, parâmetros, configurações e passos importantes para a correta visualização do processo.• Você pode usar imagens para ilustrar os procedimentos.
Informações Técnicas
• Indique as tabelas utilizadas na melhoria efetuada, informando o código e o nome da tabela.
• Informe todas as rotinas (sigla + nome) utilizadas.• Verifique os sistemas operacionais.
• Na etapa de geração de BT, o único arquivo que deve ser “comitado” é o arquivo em .doc do boletim.
• Em procedimentos para utilização, utilize as frases no Imperativo.
• Acessar = Acesse.• Evite palavras como:
• Erro = Inconsistência.• Acertado = Alterado.
Ponto de Atenção
• Template errado.• Erros de ortografia grosseiros.• Ausência do BT na pasta da versão.• Falta de informações para que o BT seja uma
ferramenta tanto para a equipe de SQA como para o cliente, entender de forma clara e objetiva o que foi realizado.
• Ausência de número de chamado.• Nomenclatura errada ou sem identificação do
que foi realizado.
Motivos de Rejeição