Design systems · Laboratórios · 5 min de leitura
Conduza uma revisão de contribuição
Um laboratório guiado: leve uma contribuição pela triagem e pela revisão. Leia um pedido, decida se ele é útil e único, revise o trabalho pronto com um checklist publicado e escreva uma decisão com a qual quem contribuiu consiga agir. Cerca de duas horas, sozinho ou com duas pessoas fazendo os papéis.
É na revisão que um design system ganha ou perde quem contribui. Um "ainda não está lá" vago manda a pessoa de volta ao time de produto sem nada para mostrar depois de duas sprints. Um checklist claro, com observações que dizem exatamente o que mudar, transforma a mesma revisão numa versão com o nome dela. Você vai conduzir as duas etapas de uma revisão, com um pedido real ou inventado.
O que você vai fazer:
- Ler um pedido de contribuição e fazer a triagem
- Decidir entre aceitar, juntar, adiar e recusar
- Revisar a contribuição pronta com um checklist
- Escrever uma decisão com a qual quem contribuiu consiga agir
Você vai precisar de: um pedido de contribuição (um real do seu time, ou o exemplo do Harbour abaixo), os critérios de contribuição do GOV.UK abertos numa aba, um documento para escrever e, se der, duas pessoas para fazer o papel de quem contribui e de quem revisa pelo produto. Cerca de duas horas.
1. Leia o pedido
Proposta: Seletor de quantidadeAberta por Inês, time do console da equipe · 4 de março
- A necessidade
- As pessoas definem quantos passageiros, carros ou bicicletas estão numa reserva. Hoje elas digitam um número, ou tocam num + e − feito à mão.
- Evidência
- App de reservas: seletor de passageiros na tela de busca. Console da equipe: tamanho do grupo no check-in, veículos na rampa. Em 5 sessões de check-in, 3 pessoas da equipe digitaram "2" no campo e ficaram com "12".
- Quem mais precisa
- Os dois produtos, três telas. O fluxo de pré-pedido da cafeteria (planejado) seria a quarta.
- Já existe no Harbour?
- Não. O
TextFieldcomtype="number"é o mais próximo; não tem botões nem mostra mínimo e máximo. - O que já existe
- Duas versões no código dos produtos (capturas anexadas), uma com botões de 28 px, outra com o hex solto
#2A6FC9. - O que posso dar
- Tempo de design e de pesquisa por duas sprints. O nosso dev, Tomás, pode fazer par no código.
- Status
- Aceita para desenvolvimento útil e única, triada em 11 de março
Se você não tem um pedido real, use este. Antes de decidir qualquer coisa, confira se o pedido responde a quatro perguntas. Se faltar uma, peça antes da triagem, não depois:
- Qual é a necessidade, nos termos de quem usa?
- Qual é a evidência: onde aparece, com que frequência, o que dá errado?
- Quem mais precisa: é mais de um time ou produto?
- Já existe no sistema, ou algo parecido?
2. Triagem: útil e única
Esta é a etapa de proposta do GOV.UK: útil quer dizer que há evidência de que muitos times ou serviços usariam; única quer dizer que não repete algo que já está no sistema. Escolha um de quatro resultados e escreva uma linha de motivo:
| Resultado | Quando | Exemplo de linha |
|---|---|---|
| Aceitar | Útil e única | "Aceita: os dois produtos precisam, nada no Harbour faz isso." |
| Juntar | Útil, mas um componente existente quase resolve | "Juntada ao TextField: vamos acrescentar uma variante com botões." |
| Adiar | Única, mas só um time precisa agora | "Adiada: construa na camada de produto do console; olhamos de novo quando um segundo time pedir." |
| Recusar | Não é útil, ou já está coberta | "Recusada: o Notice com tone="warning" faz isso. Aqui vai um exemplo." |
O seletor de quantidade é útil (dois produtos, três telas, um erro real na pesquisa) e único (o TextField não tem botões nem mostra limites), então é aceito. Combine um par: quem do time do sistema trabalha com quem contribuiu, e quando vai ser a revisão.
3. Revise o trabalho pronto
| Critério | Pergunta | O que vimos | Resultado |
|---|---|---|---|
| Usável | Testado com quem vai usar? | 4 sessões com a equipe do porto, 3 com usuários do app. Ninguém ficou com "12" de novo. | Passa |
| Consistente | Usa tokens e componentes do Harbour? | Os botões são Button secondary sm. Sobrou um #2A6FC9 solto no estilo de foco. | Corrigir |
| Versátil | Funciona nos dois produtos e nas duas densidades? | Confortável e compacta conferidas; funciona no modo escuro. | Passa |
| Teclado | Segue o padrão spinbutton do APG? | Seta para cima e para baixo funcionam. Home e End ainda não vão para o mínimo e o máximo. | Corrigir |
| Leitor de tela | Nome, valor e limites anunciados? | "Adultos, 2, botão giratório". O + e o − ficam fora da árvore de acessibilidade, o campo faz o trabalho. | Passa |
| Tamanho do alvo | Pelo menos 24 × 24 px (WCAG 2.5.8)? | 32 px na compacta, 44 px na confortável. | Passa |
| Documentação | Página de documentação, componente no Figma e story no Storybook? | Figma e story prontos; falta "Quando não usar" na página. | Corrigir |
Na etapa de publicação, o GOV.UK confere três coisas: usável (testada em pesquisa, inclusive com pessoas com deficiência), consistente (reaproveita estilos e componentes existentes) e versátil (funciona em vários serviços). Acrescente as checagens de que o seu sistema precisa. Um modelo de revisão:
## Revisão: <componente>, <data>
Revisores: <time do sistema>, <revisor do produto>
| Critério | Pergunta | O que vimos | Resultado |
|-----------------|---------------------------------------------------------|-------------|-----------|
| Usável | Testado com quem vai usar, inclusive com deficiência? | | |
| Consistente | Só tokens e componentes existentes? | | |
| Versátil | Todo produto, modo e densidade a que se destina? | | |
| Teclado | Segue o padrão do APG para o papel dele? | | |
| Leitor de tela | Nome, papel e valor anunciados? | | |
| Tamanho do alvo | Pelo menos 24 × 24 px (WCAG 2.5.8)? | | |
| Documentação | Página de documentação, componente no Figma, story? | | |
Decisão: aceitar / aceitar com mudanças / ainda não
Mudanças: <numeradas, cada uma específica>
Versão: <versão>
Para o seletor, a linha do teclado usa o padrão spinbutton do APG: seta para cima e para baixo mudam o valor, Home e End vão para o mínimo e o máximo se estiverem definidos, e o foco fica no campo (WAI-ARIA APG, Spinbutton). Teste com o teclado, não lendo o código.
4. Escreva a decisão
Escreva de um jeito que quem contribuiu consiga agir sem uma reunião:
Aceitar com três mudanças, lançar na 3.7.0.
- Troque o
#2A6FC9do estilo de foco porcolor.action.primary.- Home e End devem levar ao mínimo e ao máximo (spinbutton do APG).
- Acrescente "Quando não usar" na página de documentação: para mais de 10 itens, use o
TextField. Obrigado, Inês e Tomás. Os nomes de vocês vão no changelog.
Cada mudança é uma coisa só, dá para conferir, e traz o motivo ou a fonte. "Dar um polimento no estado de foco" não é uma mudança; é um motivo para marcar outra revisão.
5. Lance e feche o ciclo
- O time do sistema faz o merge, versiona e publica a biblioteca do Figma e o pacote juntos (veja Versões e releases).
- A linha do changelog dá o nome de quem contribuiu.
- A página de documentação aponta para a pesquisa.
- O pedido original é fechado com um link para a versão, para que a próxima pessoa que procurar encontre.
- Anote quanto tempo levou do pedido ao lançamento. Com o tempo, esse número diz se o seu processo está funcionando.
6. Confira seu trabalho
Perguntas para refletir: Se você fez o papel de quem contribuiu, qual linha da decisão mais ajudou? O que faria um time de produto querer contribuir de novo?
Relacionadas
Modelos de contribuição · Componentes acessíveis · Documentação de componentes que as pessoas usam · Versões e releases · Crítica de design na prática