Como identificar e explicar jargão para seu público.
Um termo pode ser adequado para especialistas e confuso para iniciantes. Defina primeiro o público e explique termos desconhecidos na primeira ocorrência em que a explicação seja útil.
Adapte o fluxo à sua tarefa.
Identifique o conhecimento provável do leitor e marque termos que impedem a compreensão. Preserve a linguagem técnica precisa quando necessária e acrescente uma explicação simples na primeira ocorrência útil, em vez de substituir todos os termos.
- O que você fornece
- Texto especializado e perfil do leitor.
- O que você recebe
- Jargão sem explicação destacado com definições.
Veja a entrada e o resultado.
Entrada e saída ilustrativas · exemplo didático, não uma execução real do WebAct
Exemplo campo
Explain to a new customer: Configure the webhook and inspect the payload.
Exemplo completo
Set up the webhook, an automatic message sent between services, then check the payload: the data included in that message.
Carregue esta entrada no prompt e copie para o WebAct para testar a tarefa. Seu resultado pode ser diferente da ilustração.
Decisões e solução de problemas.
Termos especializados devem desaparecer da documentação para especialistas?
Não. Explique apenas o que o leitor pretendido precisa. Termos consolidados podem tornar a documentação especializada mais curta e precisa.
E se a substituição em linguagem simples for imprecisa?
Mantenha o termo original e acrescente uma definição breve ou um exemplo. Um sinônimo familiar, mas impreciso, pode causar mais confusão.
Teste com sua própria fonte.
Substitua o exemplo pelo seu material no prompt. Mantenha os requisitos necessários e copie a tarefa para o WebAct.
Personalizar e copiar a tarefa ↑