Documentação, Handoff e QA: Comunicação em Product Design

Helena Kayla Lange Andrighe
VagasUX
Published in
10 min readNov 29, 2023

--

O que estou compartilhando aqui são métodos que deram certo pra mim, deixando a relação com os stakeholders (PO/PM, Dev, QA, CS, etc) mais tranquila, diminuindo estresse e atrito, facilitando a colaboração e ajudando diferentes áreas a se entenderem melhor. A maior parte do contexto que apresento aqui ocorre dentro de uma estrutura corporativa e com métodos ágeis, mas é importante ressaltar que essa recomendação é aplicável a outras configurações.

Durante minha jornada como designer enfrentei problemas com falta de documentação de processos, produtos, features, alterações etc. Outra questão é o frequente enrosco entre designers e desenvolvedores. Provavelmente você também já passou por isso em algum grau.

Se você ainda não teve experiência em uma empresa ou não está familiarizado com o uso de um Design System, aviso que utilizarei termos relacionados. Não se desespere; este é um convite para explorar novos conceitos e desafios.

Ouroboros (Ke Huy Quan), também conhecido como OB, em primeiro plano, construindo um dispositivo na TVA, com Loki (Tom Hiddleston) e Mobius (Owen Wilson) olhando para ele por cima de uma mesa. Plano médio, ângulo contra-plongé. Cena retirada da série Loki. OB é o único engenheiro da empresa, responsável pela manutenção e da criação de novos produtos. Também escreveu o manual da agência, com descrição e instruções sobre todos os dispositivos usados pela AVT, entregue a todos os funcionários.
Ouroboros (O.B.) construindo um dispositivo na AVT. OB é o único engenheiro da empresa, responsável pela manutenção e criação de novos produtos. Também escreveu o manual da agência, com descrição e instruções sobre todos os dispositivos usados pela AVT, entregue a todos os funcionários.

Como designer, especialmente em níveis júnior e possivelmente intermediário, muitas vezes aceitamos o processo estabelecido pela empresa, com espaço para sugestões, mas sem necessariamente ditar as regras. Este é um aspecto natural do desenvolvimento profissional. Além disso, é válido mencionar que quanto maior o nível de maturidade do design na empresa, mais fluido pode ser o processo de documentação e handoff, e nosso papel é aprimorá-lo.

Skills importantes: saber comunicar e colaborar. Sem desenvolver essas habilidades, você vai nadar e morrer na praia.

Prepare-se para explorar este método de handoff, descobrindo como a documentação eficiente não apenas facilita o processo, mas também eleva a colaboração entre design e desenvolvimento.

Antes de tudo, 2 mantras:

  • Organize seu arquivo!!!!!!! A seção é sua melhor amiga, use um sumário e cuidado para não ter muitas páginas no Figma. Se você precisar de um local para referências, testar possibilidades etc, agrupe tudo isso em uma página ou sessão e deixe claro o que é. Não deixe as outras pessoas perdidas.
Exemplo de organização de um arquivo no Figma (informações, componentes e telas). Contém sessões, widget do Jira e widget de sessões, ambos do próprio Figma.
Exemplo de organização de um arquivo no Figma (informações, componentes e telas). Contém sessões, widget do Jira e widget de sessões, ambos do próprio Figma.
  • Documentação deve ser detalhada. Peque pelo excesso. Melhor ser redundante do que ter informação de menos.

📙 Documentação: Comunicar para o futuro, para todos

O.B. segura o manual da AVT em uma mão e um TemPad (dispositivo que permite realizar as missões) na outra. Ele está informando para Loki e Mobius que tudo o que se precisa saber sobre o dispositivo está no manual, enquanto está atrás da sua mesa. Meio primeiro plano, ângulo normal. Ao fundo, a sua sala, com prateleiras e ferramentas. Loki e Mobius não aparecem. Cena retirada da série Loki.
O.B. com o manual da AVT e um TemPad, está explicando para Loki e Mobius que tudo o que há para saber sobre o dispositivo está no manual.

Invariavelmente você não será a primeira, nem a última pessoa a trabalhar em um produto. É complicado não saber porque uma decisão foi tomada de uma forma e não de outra, ou como deveria ser o comportamento de um componente, por exemplo.

Uma documentação é um organismo vivo, serve para todos da empresa que possam vir a ter contato com o produto, e deve ser construído em colaboração. Parte do nosso trabalho (dividido com outros stakeholders, mas principalmente PM/PO) é manter um histórico atualizado do que foi, é e será o produto. Documentação é para colocar todo mundo na mesma página do que está acontecendo. Deve ser confiável.

Dependendo do projeto (se haverá um discovery muito amplo, se é um novo produto, se são features menores etc), você já terá algumas definições antes de iniciar qualquer coisa. Anote tudo. Todas as dúvidas, insights, questionamentos, ideias. Isso já é documentação. Esses dados servem para nós mesmos (a memória é uma coisa interessante, mas falha) e quem vem depois precisa entender como as decisões foram tomadas. Pense no curto, médio e longo prazo.

Imersão/Discovery e Definição

Tenha um board (Miro, Mural, Figjam, etc) para reunir todas as informações de contexto, pesquisa, referências, etc. Eu prefiro, em relação a um documento apenas escrito, pois permite ver tudo de uma vez só e nos dá mais liberdade de interagir com o conteúdo que está ali.

Exemplos de boards de discovery no Figjam
Exemplos de boards de discovery no Figjam
Exemplos de boards de discovery no Figjam

O melhor cenário é o que toda a documentação está em apenas um lugar, mas esse tipo de arquivo nem sempre funciona para todo mundo e possivelmente há um local (colaborativo, online) onde é feita a documentação técnica, com regras de negócio, descrições, tabelas e outras informações (Notion, Confluence, Get Outline, etc). É para esse repositório que o link desse board deve ir, de modo que as informações fiquem sempre atualizadas. Lembre-se de também incluir o link da documentação no board, assim quem chega em um consegue ir para o outro facilmente.

No Figma quase tudo pode. Mas é importante entender a viabilidade técnica do que vai pro ar com antecedência e não sair criando mil coisas que não podem ser implementadas, ou que demandam muito esforço.

Envolva uma pessoa desenvolvedora desde o início. Se você não sabe quem ficará responsável pelo desenvolvimento, puxe alguém para tirar dúvidas e ficar a par do que pode vir a ser feito. Não precisa, e talvez não haja tempo para que vocês fiquem pareados até o fim da entrega, mas é legal ter um ponto focal pra conversar. Isso é mútuo: dúvidas e questionamentos suas sobre desenvolvimento e da pessoa desenvolvedora sobre design.

Desenvolvimento (de Design)

Nessa fase, as orientações anteriores não mudam (anote tudo, cuide do seu dev). Talvez aqui já exista uma melhor definição sobre quem vai codar. Mantenha um ponto focal pra dúvidas mesmo assim (se você já souber quem vai desenvolver, passa a ser essa pessoa) e continue anotando tudo.

Tudo que pode ser um componente ou um elemento reutilizável, deve ser. Inicialmente pode parecer mais trabalho, mas é um investimento no médio/longo prazo para todo mundo. Economiza tempo na documentação e handoff atual, além de usos futuros e manutenção.

Exemplos de documentação e tokenização de guias de estilos e componentes.

Especificações de Design

Tudo. Tamanho, distância, espaçamentos, cores, tipografia, tokens etc. Existem plugins que ajudam nessa especificação. Eu uso esse, mas tem outros. Se já houver um Design System desenvolvido, facilita porque não precisa fazer dos componentes, apenas das páginas. Quanto mais avançado o produto, menos disso vai ficando para o dia a dia.

Exemplos de especificações de Design, realizados com o plugin supracitado.

Com o advento do Dev Mode no Figma, isso tudo foi facilitado. As Variáveis também ajudam muito, mas está disponível apenas no plano pago. Não vou me alongar nisso, apenas aponto que existem essas possibilidades. Se o seu contexto abraça essa funcionalidade, use também.

Fluxos

Pode ser wireflow, sitegrama, userflow, sitemap, blueprint resumido do serviço, validação condicional, etc. O software pouco importa (Figma, Figjam, Excel, Flowchart, PowerPoint, etc). O importante é ter a documentação do fluxo que foi projetado além das telas e das interações no protótipo.

Muitos detalhes são mapeados nesses fluxos. Tenha mais de um se for preciso.

Exemplos de fluxos de um produto e/ou processos que podem estar incluídos em uma documentação.

Descrição das telas e comportamento de cada elemento

É importante ter definição e descrição detalhada sobre interações, microinterações, comportamentos e diferentes status. Saiba como a sua equipe identifica os componentes, alguns tem mais de um nome técnico (ex: input field, textbox, texfield).

Mapeie o máximo de status possíveis no discovery e ao longo do seu desenvolvimento (use seus stakeholders pra isso), inclua imagens de como um determinado componente deve funcionar.

A 1ª das imagens abaixo é como eu prefiro fazer essa documentação: título da tela/fluxo, o rótulo, qual o tipo do componente e seu comportamento, além de informações de status e outros comentários necessários; quando há alteração de algo que já foi desenvolvido, descrevo e incluo o link da tarefa em que a mudança foi feita. Evito usar prints de todas as telas ineiras pois é muito fácil ficar desatualizado, é mais chato alterar, então prefiro apenas utilizar o link do figma.

Exemplos de descrição de componentes e comportamentos nas telas e fluxos.

Essa etapa é muito importante para todos. PM/PO usa pra descrever tarefa, Dev tem certeza do que está desenvol vendo, QA tem mais segurança no teste.

Ok. Temos um produto validado e documentação escrita. E agora?

👐 Handoff: Comunicar para o presente, para o time

Loki assume a liderança ao entrar na sala do núcleo temporal, segurando o manual da AVT, flanqueado por O.B., Mobius e Hunter B-15  (Wunmi Mosaku). Plano geral médio, ângulo levemente contra-plongé. Cena retirada da série Loki.
Loki assume a liderança ao entrar na sala do núcleo temporal, segurando o manual da AVT.

Nas minhas experiências, não trabalhei com ferramentas de handoff (Invision, Zeplin, etc), então compartilho outras informações. Meu foco aqui é no que geralmente passa batido: conversa e alinhamento. Não é de hoje que existe rixa entre desenvolvedores e designers, um rosnando de cada lado, e também não é hoje que ela vai sumir. Mas podemos tentar diminuir esse atrito e evitar retrabalho (de todos).

Em alguns contextos, há uma etapa de refinamento com os devs antes da entrega oficial. Gosto muito, nos permite mapear possíveis pontas soltas que podem ter ficado pelo caminho. Isso também ocorre na planning.

De qualquer forma, deve haver uma reunião. De nada adianta desenvolver um protótipo lindão que não vai ser implementado. Lembre-se do que eu falei no lá no início: saiba se comunicar. Agora é a hora de apresentar o case, mostrar a sua expertise e defender o que você fez.

  • Se reúna com quem está envolvido nesse delivery
  • Compartilhe a sua tela
  • Dê um overview sobre a dor, quais foram as descobertas principais e como isso se relaciona com a saída (o produto em si).
  • Explique o fluxo
  • Converse. Anote. Se alinhem 🌟 🪐

🧐 Design QA: Comunicar qualidade, para o usuário

Loki sacrifica o seu tempo para ajudar todos e garantir que o plano será executado. Primeiro plano, ângulo normal. Cena retirada da série Loki.
Loki sacrifica o seu tempo para ajudar todos e garantir que o plano será executado.

Certo. Nós criamos, outras pessoas desenvolveram. Mas como ter certeza que está funcionando como deveria? Esse processo é o Quality Assurance (Garantia de Qualidade), em que alguém vai testar todo o produto desenvolvido antes de liberar para o usuário. Design QA também é uma etapa do processo até a entrega e deve ser feita para garantir consistência e qualidade visual do que foi desenvolvido.

Normalmente, há uma pessoa (ou um time) de tecnologia para fazer essa verificação, porém assim como o desenvolvedor, o QA provavelmente não sabe sobre Design como nós (e não é uma obrigação, está tudo bem). O QA tem uma infinidade de cenários pra verificar e nós, Designers, já sabemos o que foi alterado e como a especificação de Design deve funcionar. Facilite. Faça você a validação de Design.

Exemplos de como realizar QA: descrevendo na própria tarefa as inconsistências ou utilizando uma página no arquivo do Figma.

Lembre-se: não dá pra ter tudo sempre. Concessões (de todos os lados) podem ser necessárias em todas as etapas.

🌷 E depois?

Os muitos fios do Multiverso da Marvel na forma de Yddgrasil, a árvore da vida e centro da mitologia nórdica. Loki está mantendo tudo conectado para evitar o colapso da realidade. Nenhuma pessoa aparece na foto, plano médio, ângulo normal. Cena retirada da série Loki.
Os muitos fios do Multiverso da Marvel na forma de Yddgrasil, a árvore da vida e centro da mitologia nórdica. Loki está mantendo tudo conectado para evitar o colapso da realidade.

No fim das contas, o nosso papel é também assegurar que a empresa enxergue o valor do Design, e essas ferramentas são importantes pra isso. Se temos um produto rodando, mas uma documentação desatualizada, incompleta ou que ninguém lê, morremos na praia de novo (só que com um pouco mais de areia no ouvido).

Mantenha tudo atualizado quando houver alterações e um histórico do que havia ali antes (não apague, apenas separe e diferencie). Também indico uma timeline no repositório da documentação técnica com as descrições:

  • 00/00/00: Descrição do que foi alterado. Link da tarefa. Link do novo mockup/arquivo do Figma.

Uma fonte única de verdade é o cenário ideal, mas o nosso público alvo envolve pessoas que não tem acesso à todas as ferramentas, então é melhor que essa informação conste em mais de um lugar, mas não muito mais do que isso (sob risco de haver muitos lugares para manter atualizados). O segredo do processo é encontrar o equilíbro, e isso só se define com tentativa e erro.

Uma documentação bem escrita e um handoff bem feito é crucial para o sucesso do produto. Qualidade afeta o time todo (e o usuário). É importante que todos saibam como as coisas funcionam, e qual foi o processo de tomada de decisão, evitar retrabalho ou também possibilitar reavaliações posteriores.

Por fim:

Não existe “by-the-book”: Agora, saia para o mundo. Esse é um guia com dicas. Use, pivote, modifique, adapte, vire do avesso: nada disso é escrito em pedra.

--

--