Menu

Guia de documentação de teste de software (por que é importante)

software testing documentation guide

Experimente Nosso Instrumento Para Eliminar Problemas

Em minha carreira de teste de software, nunca ouvi pessoas falando muito sobre documentação de teste de software. A opinião geral sobre a documentação de teste é que qualquer pessoa que tenha tempo livre pode fazer a documentação, como um caso de teste, plano de teste, relatório de status, relatório de bug, proposta de projeto, etc.

Mesmo eu não me estressei mais sobre a documentação, mas posso dizer que é meu hábito colocar todos os dados em preto e branco e atualizar outros sobre isso também.

Guia de documentação de teste de software (por que

O que você aprenderá:

Minha experiência

Só quero compartilhar minha experiência com você:

Havíamos entregado um projeto (com um problema desconhecido) para um de nossos clientes (cliente irritado). E eles encontraram o problema no lado do cliente, o que era uma situação muito ruim para nós e, como de costume, toda a culpa era do QA.

O problema era algo relacionado à compatibilidade de um site. Quando me ocorreu, eu estava tendo a prova de que não recebi esse documento de requisito que afirma que eu também tenho que verificar a compatibilidade do site. Graças a Deus eu estava seguro.

Essa foi a lição para mim, percebi a importância da documentação e a partir daquele dia comecei a trabalhar em documentos e criar documentos de teste como plano de teste, casos de teste, checklist de teste de sanidade, relatório de bug e muitos.

“A tinta é melhor do que a melhor memória” - provérbio chinês

Documentação de teste: o que é isso?

Todos nós lemos vários artigos sobre tecnologias e métodos de teste, mas quantos de nós viram artigos sobre documentação? Sem dúvida, são poucos. Será que os documentos não são importantes? Não, mas é porque ainda não percebemos a importância dos documentos.

Mas, se observarmos, então o fato é, os projetos que possuem todos os documentos possuem um alto nível de maturidade.

A maioria das empresas não dá nem mesmo pouca importância à documentação tanto quanto dão ao processo de desenvolvimento de software. Se pesquisarmos na web, podemos encontrar vários modelos sobre como criar vários tipos de documentos. Mas quantos deles são realmente usados ​​por organizações ou indivíduos?

O fato é que uma documentação cuidadosa pode economizar o tempo, os esforços e o dinheiro de uma organização.

Ao buscar qualquer tipo de certificação, o motivo pelo qual há ênfase na documentação é apenas porque mostra a importância do cliente e dos processos para o indivíduo e a organização. A menos que você seja capaz de produzir um documento confortável para o usuário, não importa quão bom seja o seu produto, ninguém o aceitará.

É minha experiência, nós temos um produto, que tem uma funcionalidade um pouco confusa.

Quando comecei a trabalhar nisso, pedi alguns documentos de ajuda ao gerente e recebi a resposta 'Não, não temos nenhum documento' Então fiz um problema sobre isso porque, como um QA que eu conhecia, ninguém consegue entender como usar o produto sem documentos ou treinamento. E se o usuário não ficar satisfeito, como vamos ganhar dinheiro com esse produto?

“A falta de documentação está se tornando um problema de aceitação” - Wietse Venema

Até mesmo a mesma coisa se aplica aos manuais do usuário. Tomemos um exemplo da Microsoft, eles lançam todos os produtos com os documentos adequados, até para o Office 2007 temos esses documentos, que são muito explicativos e fáceis de entender para qualquer usuário. Essa é uma das razões pelas quais todos os seus produtos têm sucesso.

usando regex em c ++

Em pequenas empresas, sempre ouvimos “rejeições de projetos na proposta ou na fase inicial”, é apenas porque a documentação da proposta carece de uma linguagem concisa e expressiva e para mostrar a capacidade da organização.

Não é que as pequenas empresas não possam entregar projetos de boa qualidade, mas é sua incapacidade de expressar sua capacidade. (Eu também trabalho com uma pequena organização de 80 funcionários, e ouvi isso muitas vezes)

Pessoalmente, sinto que a Qualidade é o único departamento que pode tornar isso possível. Somos o único departamento que pode argumentar sobre isso e pode fornecer um futuro de sucesso para nossas organizações.

Vamos organizar toda a discussão em alguns pontos na perspectiva da qualidade:

- Esclarecer os objetivos e métodos de qualidade
- Garantir clareza sobre as tarefas e consistência de desempenho
- Garantir a coordenação interna no trabalho do cliente
- Fornecer feedback sobre ações preventivas
- Forneça feedback para o seu ciclo de planejamento
- Crie evidências objetivas do desempenho do seu sistema de gestão da qualidade

10 dicas para ajudá-lo a atingir a meta de documentação de teste

Como mencionei em meu post anterior, em geral, o entendimento sobre a documentação de teste de software é “Isso pode ser feito apenas por quem tem tempo livre”. Precisamos mudar essa mentalidade e só então podemos alavancar o poder da documentação em nossos projetos.

Não é que não saibamos como fazer a documentação certa. Nós simplesmente não achamos que seja importante.

Todos devem ter modelos padrão para todos os tipos de documentação, começando da estratégia de teste, plano de teste, casos de teste e dados de teste até o relatório de bug.

Estes são apenas para seguir alguns padrões (CMMI, ISO, etc.), mas quando se trata da implementação real, quantos desses documentos são realmente usados ​​por nós? Precisamos apenas sincronizar nosso processo de qualidade com os padrões de documentação e outro processo em uma organização.

A coisa mais simples de seguir todos os tipos de documentação é envolver uma pessoa no projeto, desde a fase inicial, que entende a dinâmica, domínio, objetivo e tecnologia do projeto. E quem melhor do que uma pessoa de QA para isso (é claro que há escritores técnicos presentes para fazer isso - mas considerando um cenário geral de pequenas empresas onde escritores técnicos não estão presentes).

Para atingir esse objetivo de teste e documentação, sinto que precisamos nos concentrar em alguns pontos.

Aqui estão as 10 principais dicas para ajudá-lo a atingir a meta de documentação de teste:

# 1) O controle de qualidade deve envolver a primeira fase do projeto para que o controle de qualidade e a documentação trabalhem juntos.

#dois) O processo definido pelo QA deve ser seguido por técnicos, o que ajuda a remover a maioria dos defeitos em um estágio bem inicial.

# 3) Apenas criando e mantendo Modelos de teste de software não é suficiente, forçar as pessoas a usá-los.

# 4) Não apenas crie e deixe o documento, atualize como e quando necessário.

# 5) O requisito de mudança é uma fase importante do projeto, não se esqueça de adicioná-los à lista.

# 6) Use o controle de versão para tudo. Isso o ajudará a gerenciar e rastrear seus documentos facilmente.

# 7) Facilite o processo de correção de defeitos documentando todos os defeitos. Certifique-se de incluir uma descrição clara do defeito, reproduzir etapas, área afetada e detalhes sobre o autor enquanto documenta qualquer defeito.

# 8) Tente documentar o que é necessário para você entender o seu trabalho e o que você precisará produzir para as partes interessadas, sempre que necessário.

# 9) Use o modelo padrão para documentação. Como qualquer modelo de planilha do Excel ou modelo de arquivo doc, siga-o para todas as suas necessidades de documento.

# 10) Compartilhe todos os documentos relacionados ao projeto em um único local, acessível a todos os membros da equipe para referência e também para atualização sempre que necessário.

Não estou dizendo que, aplicando etapas, você obterá resultados repentinos. Sei que essa mudança não acontecerá em um ou dois dias, mas pelo menos podemos começar para que essas mudanças comecem a acontecer lentamente.

Afinal “a documentação precisa de documentação”. Não é?

Existem centenas de documentos usados ​​no ciclo de vida de teste e desenvolvimento de software.

Documentos importantes de teste de software

Aqui estou listando alguns documentos de teste de software importantes que precisamos usar / manter regularmente:

1) Plano de Teste
2) Design de teste e Especificação de Caso de Teste
3) Estratégia de Teste
4) Relatórios de resumo de teste
5) Relatório de status semanal
6) Documentos / manuais do usuário
7) Relatório de aceitação do usuário
8) Avaliação de risco
9) Registro de teste
10) Relatório de erros
onze) Dados de teste
12) Análise de Teste

Além disso, os testadores de software precisam consultar regularmente os seguintes documentos:
1) Especificações de requisitos de software
2) Documentos funcionais

Conclusão

Os documentos de teste de software sempre desempenham um papel importante na fase de desenvolvimento / teste do projeto. Portanto, sempre mantenha as coisas documentadas sempre que possível. Não confie na comunicação verbal. Esteja sempre do lado seguro.

A documentação não só o salvará, mas também ajudará a organização a longo prazo, economizando milhares de dólares em treinamento e, mais importante, na correção de problemas causados ​​pela falta de documentos de desenvolvimento e teste.

Não documente apenas para evitar apontar o dedo para você, mas o hábito da documentação certamente trará uma abordagem sistemática para o seu processo de teste, deixando o teste ad hoc para trás.

Sobre o autor: Este artigo foi escrito por um membro da equipe STH Tejaswini. Ela está trabalhando como gerente de QA em uma organização.

Que outros documentos você mantém em suas atividades diárias de teste?

Leitura recomendada

^