Clube do Livro VTEX: Objetivos de aprendizado

Este post faz parte de uma série de conteúdos produzidos pelo time de tech writers da VTEX em nosso projeto do clube do livro, em que discutimos o livro The Product is Docs. Neste post nós vamos discutir o pilar do aprendizado no contexto de Technical Writing. Iremos abordar quais os possíveis objetivos de aprendizado de uma documentação e como utilizá-los.

Os objetivos de aprendizado são metas ou resultados que você pretende atingir com a documentação. Eles são importantes para alinhar o conteúdo abordado na documentação às necessidades do usuário. No contexto de Technical Writing, desenvolver objetivos de aprendizado é uma prática que fornece direção e estrutura para os tech writers planejarem o conteúdo.

Existem diversos tipos de objetivos de aprendizado, como:

Conscientização: entender o que são determinados conceitos ou funcionalidades e para que servem.
Compreensão: entender como determinados conceitos ou funcionalidades operam.
Habilidade aplicável: aprender a realizar uma tarefa.

Quando você escrever, aplique os objetivos do usuário para definir um propósito abrangente para os tópicos, capítulos e manuais. Identificar as metas do usuário pode ser um primeiro passo útil para descobrir e estabelecer objetivos de aprendizado. (p. 86)

É importante saber distinguir os objetivos de aprendizado e as metas do usuário. As metas do usuário são metas reais, pragmáticas e relacionadas ao uso do produto, enquanto os objetivos de aprendizado são relacionados à documentação e servem para guiar o technical writer durante a escrita.

Benefícios dos objetivos de aprendizado na criação da documentação

Cada tópico abordado na documentação precisa de pelo menos um objetivo de aprendizado. O ideal é que cada artigo de documentação atenda somente a um objetivo de aprendizado, mas em alguns casos pode ser necessário abordar mais de um objetivo. Ter esse objetivo definido ajuda na criação de conteúdo em etapas e reduz a chance de escrever algo que se sobreponha a outra documentação.

Veja nas seções abaixo as possíveis vantagens de definir objetivos de aprendizado para a documentação.

Mais fácil de pesquisar e escrever

Artigos com um objetivo de aprendizado têm um público bem definido, focam em objetivos específicos do usuário e ajudam os clientes a resolver problemas do mundo real.
Um artigo sem um objetivo de aprendizado não tem direção. É menos provável que um technical writer seja capaz de pesquisar com engenheiros ou gerentes de produto se não houver nenhum objetivo.

Mais fácil de organizar

Um objetivo ajuda o tech writer a traçar a história que seu artigo conta.
É difícil estruturar um artigo sem ter um objetivo de aprendizado em mente.

Mais fácil de manter

Artigos com um objetivo de aprendizado são mais fáceis de manter porque têm uma estrutura clara e lógica.
Artigos sem um objetivo de aprendizado podem parecer uma coleção aleatória de informações.
Artigos sem um objetivo de aprendizado são mais difíceis de manter de uma versão para outra.

Mais fácil de usar

Artigos com um objetivo de aprendizado definem claramente as expectativas do usuário.
Artigos escritos sem um objetivo de aprendizado são mais suscetíveis a frustrar os leitores.

Traçando um caminho para um objetivo de aprendizado forte

O objetivo de aprendizado indica o destino desejado para a documentação, ou seja, ele determina como será o planejamento, a pesquisa e a criação do conteúdo.

Para um tech writer, ser capaz de indicar o ponto de partida depende de conhecer seu público e compreender os objetivos que os usuários estão tentando alcançar quando encontram a sua documentação.

Para isso, é essencial planejar cuidadosamente o escopo da documentação e lembrar que nenhum artigo pode cobrir todos os cenários e a história por trás de um recurso ou produto.

Antes de começar a descrever um passo a passo, também é importante incluir pré-requisitos para ajudar os usuários a entenderem se eles estão prontos para seguir os passos que virão adiante.

Usando objetivos de aprendizado separadamente e em conjunto

É possível que uma documentação apresente mais de um objetivo de aprendizado. Se os objetivos de aprendizado estiverem intimamente relacionados, pode ser uma boa ideia incluir todo o conteúdo em uma única documentação. Foque na otimização para ter uma experiência de documentação direta e fácil de navegar.

A matriz de objetivos de aprendizado

Para identificar o público e facilitar a definição de objetivos de aprendizado de uma documentação, o time do Splunk propõe o uso de uma matriz de Proficiência X Compreensão. A posição do objetivo de aprendizado na matriz pode guiar o tech writer para entender a quantidade e a estrutura da documentação que serão necessárias para que um leitor atinja os seus objetivos.

Matriz de objetivos de aprendizado

Fonte: The Product is Docs, tradução e adaptação feita pelo time VTEX.

Compreensão

O eixo vertical da matriz, Compreensão, mede o nível de profundidade do conteúdo, identificando como você deseja que os seus leitores consumam a sua documentação. Quanto mais próximo da origem, menor é o nível de compreensão exigido. Este eixo é categorizado em cinco níveis diferentes:

Reconhecimento: os usuários sabem que a funcionalidade existe e o que ela faz.
Apreciação: os usuários sabem o que a funcionalidade pode fazer por eles.
Aplicabilidade: os usuários são capazes de inicializar, instalar, lançar, configurar, e rodar a funcionalidade.
Análise: os usuários sabem utilizar a funcionalidade e buscam melhorar eficiência, performance e resultados.
Arquitetura: os usuários criam e projetam as suas próprias funcionalidades.

Proficiência

O eixo horizontal da matriz, Proficiência, identifica o quão proficiente você deseja que os seus leitores sejam em relação ao conteúdo em questão. Quanto mais próximo da origem, menor é a proficiência desejada. Este eixo é categorizado em quatro níveis diferentes:

Competência: os usuários seguem este passo a passo palavra por palavra e o utilizam esporadicamente.
Esforço consciente: os usuários se sentem confortáveis utilizando a funcionalidade quando têm acesso à documentação da mesma.
Proficiência: os usuários já não precisam mais de instruções. Eles conseguem fazer o que é esperado deles sem nenhuma dificuldade.
Competência inconsciente: os usuários dominam a funcionalidade e podem ensinar aos outros sobre a funcionalidade.

Usando a matriz de objetivo de aprendizado

Para utilizar a matriz de objetivo de aprendizado, o time da Splunk sugere seguir os passos abaixo.

Pense no que você deseja que o usuário alcance ao ler o seu conteúdo e posicione este objetivo na matriz.
Escreva o objetivo de aprendizado, sendo meticuloso(a) com a escolha das palavras para refletir com precisão o nível de compreensão e proficiência desejados.
Com base no objetivo de aprendizado descrito, valide a posição inicial do objetivo na matriz elaborada e ajuste-a caso necessário.
Repita este processo, escrevendo diferentes objetivos de aprendizado para essa mesma funcionalidade. Utilize o seu próprio brainstorm e qualquer consideração relevante do gerente de produto ou engenheiros.
Compartilhe e discuta a lista e matriz de objetivos de aprendizado, colhendo feedbacks do seu time sobre as entregas desejáveis. Compartilhar a matriz de objetivo de aprendizado irá te ajudar a dar mais visibilidade sobre as documentações que você está produzindo e como elas irão ajudar o cliente.

A elaboração da matriz de objetivo de aprendizado irá te auxiliar nas etapas iniciais do processo de documentação, ajudando a focar nos usuários e no que eles precisam, e não necessariamente em como você irá apresentar a informação.

Refinando objetivos de aprendizado

Os objetivos de aprendizado devem funcionar como uma bússola que indica as direções da documentação para o usuário. Para isso, é preciso ter objetivos de aprendizado sólidos que refletem a realidade da audiência, incluindo seu nível de experiência.

Alguns objetivos de aprendizado devem ser quebrados em objetivos menores para representar a realidade do usuário. Considere as perguntas abaixo para definir como separar o objetivo de aprendizado com consistência:

O que o usuário precisa saber para alcançar essa meta?
Quanta informação o usuário precisa saber?
Como o usuário sabe que alcançou o objetivo de aprendizado da documentação?

Recursos que ajudam a criar objetivos de aprendizado

Para documentar uma nova funcionalidade, o tech writer deve definir os assuntos que a documentação abordará, se possível organizando-os em tópicos. Em casos de atualização de documentação, é mais provável que o tech writer foque em um ou dois assuntos. Em ambos os cenários, qualquer conteúdo novo deve ser informado pelo objetivo de aprendizado.

Veja as sugestões abaixo para moldar um bom objetivo de aprendizado:

Fale com o gerente do produto que você documenta sobre metas do usuário e especificações e requisitos da utilização do produto.
Leia as especificações e os requisitos do produto para entender a jornada do usuário e os benefícios e efeitos do produto.
Procure documentações internas de engenheiros para traçar o caminho que o usuário deve percorrer.
Acompanhe os feedbacks dos usuários para saber se o conteúdo está sincronizado com o objetivo de aprendizado.

Citações

Traduzimos livremente alguns trechos do livro que mais chamaram nossa atenção:

Citação	Página
[Os objetivos de aprendizado] indicam tarefas intelectuais - como identificar, explicar, distinguir entre opções, decidir e seguir etapas - que um usuário pode realizar em um cenário do mundo real.	87
Para um tech writer, indicar o ponto de partida depende de conhecer seu público e compreender os objetivos que os usuários daquele público estão tentando alcançar quando encontram sua documentação.	90
Os objetivos de aprendizado precisam ser modulares e devem ser utilizados juntos ou separadamente.	92
(...) um objetivo de aprendizado forte deve refletir a definição do público e ser apropriado para o nível de experiência do público.	96
Ter qualquer tipo de objetivo de aprendizado é melhor do que não ter nenhum objetivo.	97
Converse com o gerente de produto sobre os objetivos do usuário e procure informações nas especificações do produto ou na documentação dos requisitos.	101
Leia os requisitos e especificações do produto para compreender as histórias dos usuários e os efeitos pretendidos, benefícios ou outros resultados do desenvolvimento de um recurso.	102
Enquanto as especificações do produto são úteis para identificar objetivos de aprendizado mais amplos, as documentações internas de engenharia podem ajudá-lo a descobrir como conduzir o usuário até o objetivo.	102
Feedbacks de usuários podem ser úteis para mostrar se uma documentação está identificando e apoiando um objetivo de aprendizado de forma eficaz.	103
Trabalhar com objetivos de aprendizado é uma ótima maneira de se conectar com seus usuários porque ajuda a criar uma experiência de documentação que os educa e os capacita.	103