Trechos. Como facilitar o processo de trabalhar com a documentação


Olá Habr! Meu nome é Pavel Lesyuk. Eu sou um testador de aplicativos móveis nativos. No meu artigo anterior , forneci uma lista de ferramentas que testadores e alguns outros especialistas podem usar para aumentar a produtividade de seu trabalho.

Em uma nova série de artigos, gostaria de examinar mais de perto algumas ferramentas e ilustrar seu uso com exemplos. O primeiro artigo será dedicado à solução mais eficaz e mais simples - trechos.

Snippets - são fragmentos do texto (código), que são armazenados para reutilização posterior. Os trechos vêm em três formas: estático (texto sem formatação), dinâmico (usando variáveis) e script (usando código).

Neste artigo, veremos exemplos de criação de snippets estáticos e dinâmicos ao trabalhar com aplicativos móveis e de desktop. Lembre-se de que os snippets são uma ferramenta universal que pode ser usada por qualquer especialista que trabalha com informações textuais.

Ferramentas de mesa


Vamos considerar todo o processo usando o TextExpander programa para MacOS como um exemplo . Existem versões para Windows, Chrome, iOS. Esta é a ferramenta mais funcional. Custo: US $ 4,16 por mês ou US $ 3,33 por mês para uma assinatura anual. Como alternativa, eu recomendaria tentar o PhraseExpress . Existem versões para macOS, Windows, iOS, Android.

O MacOS substituiu automaticamente. Você pode encontrá-lo no caminho: “Configurações” → “Teclado” → “Texto”.


Ele suporta apenas texto sem formatação, portanto, pode ser usado apenas para modelos simples.

Preenchendo Relatórios de Defeitos


Digamos que queremos automatizar o processo de criação de relatórios de defeitos. Primeiro, crie o modelo mais completo para preencher a descrição no sistema de rastreamento de erros do Jira. Levaremos em conta o fato de que, no futuro, desejaremos criar todas as combinações dos campos usados ​​com mais frequência para preencher a descrição dos relatórios. Vamos começar.

Criando um grupo de trechos


Primeiro, crie um grupo de trechos e dê um nome a ele.

Atribuindo um nome e abreviação


Agora você precisa criar um novo trecho, dê um nome e abreviação. Nome - identificador com o qual você pode determinar rapidamente o conteúdo do snippet e localizá-lo, se necessário. Abreviação - uma sequência de caracteres, ao inserir o conteúdo do snippet.

Aqui estão algumas propriedades de boas siglas:

  1. . , ( ). «report», . , , . , . , «,report» . — .
  2. . . , . , «,bg», «,bg2», «2» .
  3. . , . , «Bug report» «,report» «,bg».
  4. . .

Na maioria dos casos, prefiro usar nomes e abreviações em inglês. Vamos chamar o primeiro trecho de código “Ambiente, pré-condições, etapas, resultado real e esperado” (lembre-se, queremos criar mais algumas combinações desses parâmetros, por isso acho que esse nome é o mais adequado). A abreviação é ", epsae", que corresponde às primeiras letras das palavras no nome. Você também pode configurar a distinção entre maiúsculas e minúsculas.

Preenchimento de snippet


Preencha o snippet com conteúdo para descrever o relatório.

Criamos um snippet estático. Os caracteres "*" e "#" são a sintaxe de formatação no Jira (lista em negrito e numerada, respectivamente). Vamos ver como a inserção funciona.


Muito melhor do que inserir tudo isso manualmente ou procurar o modelo desejado nas anotações, não é? Nas configurações, você pode definir as opções de inserção de snippet. A inserção pode ocorrer imediatamente após a entrada ou após pressionar a tecla de limite.

Da mesma forma, podemos criar modelos para todas as combinações de campos usadas na descrição do relatório de defeitos. Você pode criar exatamente o conjunto de modelos que usaremos com mais frequência.

Por exemplo, eu tenho esse conjunto da seguinte maneira:

  • Condições prévias, etapas, resultado real e esperado
  • Condições prévias, resultado real e esperado
  • Etapas, resultado real e esperado
  • Resultado real e esperado

Usando elementos dinâmicos


Vejamos mais alguns exemplos.

Por exemplo, preciso incorporar rapidamente um link no texto ao preparar um relatório. Ao usar a ferramenta embutida no Jira, fica assim:


Não parece ruim, podemos começar a digitar imediatamente. Mas e se, em vez de example.com, eu quiser colar o link já copiado da área de transferência? Para fazer isso, precisamos da capacidade de criar conteúdo dinâmico dentro do snippet.

Usando elementos dinâmicos, colamos o conteúdo copiado na área de transferência e posicionamos o cursor na posição que precisamos. Vamos ver como a inserção funciona.


Agora vamos melhorar nosso primeiro modelo. Suponha que você seja um testador móvel e tenha uma frota de dispositivos móveis, parte dos quais lhe foi atribuída. Você está testando nesses dispositivos com mais frequência e gostaria de ter uma lista deles em mãos ao preparar um relatório de defeitos.

Primeiro, crie uma lista de dispositivos. Fazemos isso usando os itens opcionais para selecionar.

Em seguida, crie uma lista de hosts nos quais estamos testando. Adicione um novo trecho ao nosso grupo e use novamente os elementos opcionais.

Bem! Agora, vamos ao nosso snippet principal e o enriquecemos com conteúdo. Adicionamos a inserção de elementos opcionais de outros trechos e definimos a posição do cursor para que você possa começar a inserir texto imediatamente. Vamos ver como nosso snippet avançado funciona.




Ao inserir elementos dinâmicos que esperam algumas ações do usuário (preenchimento, seleção etc.), uma janela separada será aberta na qual as ações correspondentes precisarão ser executadas nesses elementos.

Criando modelos de anotações


Outro exemplo: criando modelos para a estrutura das notas de trabalho. Faço anotações com suporte de remarcação para compilações de aplicativos móveis com uma estrutura específica e uso trechos para gerá-los rapidamente. Abaixo está um exemplo de inserção de um modelo finalizado em notas.




Preenchendo formulários de teste


Ao trabalhar com aplicativos da Web / área de trabalho, você pode usar trechos para preencher formulários com dados.

Ao simular o pressionamento do botão Tab, a transição entre os campos ocorre automaticamente.


Comunicando


Considere criar um relatório de teste. Suponha que, uma vez por semana, escrevamos um relatório sobre novos projetos em aplicativos móveis.

Utilizamos elementos dinâmicos, texto formatado e figuras.

Como resultado, obtemos uma estrutura de relatório pronta, que pode ser preenchida rapidamente com os valores necessários e enviada uma carta.


Ferramentas do SO móvel


Android


No Android, você pode usar o Texpand ou o Gboard . Infelizmente, em ambos os aplicativos, não há possibilidade de sincronização entre dispositivos.

O Gboard suporta apenas texto sem formatação. De fato, esta é uma área de transferência estendida na qual é possível fixar alguns fragmentos.


Em Texpand oportunidade mais ampla. A versão gratuita suporta 10 trechos, datas e horários dinâmicos, colando da área de transferência e definindo a posição do cursor. Você também pode fazer backup e importar trechos para outros dispositivos.


iOS


O IOS possui uma substituição automática integrada, suporta apenas texto sem formatação.

Existem também versões do TextExpander e PhraseExpress para iOS.

No TextExpander, todos os trechos são sincronizados entre as versões desktop e móvel. Há várias limitações na versão móvel em comparação com a versão para desktop:

  1. Os trechos são abertos ao imprimir apenas quando o teclado do TextExpander está ativo (o teclado vem com o aplicativo, que pode ser ativado nas configurações do iOS).
  2. A interação com elementos dinâmicos (preenchimento, seleção etc.) funciona apenas no próprio aplicativo, no segmento "Notas". A partir daí, o trecho concluído pode ser copiado ou enviado através do menu de compartilhamento.
  3. Os trechos de script não funcionam (eles não foram considerados neste artigo).


Você pode adicionar trechos aos seus favoritos para acesso rápido a partir do teclado.

Abaixo está um exemplo de trabalho com um snippet dinâmico.


Conclusão


Examinamos o trabalho de trechos estáticos e dinâmicos usando o exemplo da criação de documentação de teste. Eles também podem ser usados ​​para criar vários tipos de cartas (listas de e-mail repetidas, ofertas de emprego etc.), a estrutura de documentos e notas, geração de código e muito mais .

Obrigado por ler o artigo até o fim. Espero que as informações contidas nele sejam úteis para você e que você possa economizar tempo usando-as na prática. Se você tiver alguma dúvida sobre o artigo, terei prazer em responder. No próximo artigo, pretendo escrever sobre o uso de trechos de script. Enquanto isso, proponho a inscrição no meu canal Telegram , onde publico todas as outras informações sobre o tópico de teste.

Source: https://habr.com/ru/post/undefined/


All Articles