Latest / Entre Chaves / Snippet #13 Guia de escrita da Microsoft para melhorar UX e documentação

Transcript

Snippet #13 Guia de escrita da Microsoft para melhorar UX e documentação · Entre Chaves

• 0:09
  Fala galera, eu sou o Sandro, sou desenvolvedor de software
• 0:13
  aqui na DTIE. Hoje a gente vai bater um papo
• 0:16
  sobre uma dor que eu tenho certeza que todo mundo aqui já
• 0:18
  sentiu. Que é ler uma documentação de
• 0:21
  software, um reading do GitHub ou até uma mensagem de erro que
• 0:25
  parece ter sido escrita por um robô totalmente apático.
• 0:29
  A gente da área de tecnologia, a gente tem essa mania meio chata
• 0:33
  de achar que só porque a gente lida com bastante código, com
• 0:37
  agente de a que a gente precisa escrever como máquinas.
• 0:41
  Só que, na verdade, pessoal, quem leu o nosso código, quem
• 0:45
  consome a nossa API ou clica no botão do sistema?
• 0:49
  É um ser humano. E para resolver essa falha de
• 0:52
  comunicação, eu quero discutir com vocês alguns conceitos do
• 0:55
  Microsoft writing style guide, que é o guia de estilo de
• 0:59
  escrita da Microsoft. Se você não conhece, fica
• 1:02
  tranquilo. Não é como se fosse aquele livro
• 1:05
  chato, é mais um manual, é da própria Microsoft.
• 1:08
  E ele trata sobre como escrever para tecnologia atualmente.
• 1:13
  E assim, pessoal. O mais legal é que a própria
• 1:17
  empresa, né? A Microsoft, eles admitiram que,
• 1:21
  no passado, os manuais deles relacionados às tecnologias
• 1:25
  pareciam aquelas teses de doutorado.
• 1:28
  Mas teve uma mudança de chave que eles entenderam que hoje,
• 1:32
  pelo fato da tecnologia estar na mão de todo mundo, basicamente.
• 1:37
  Eles tiveram que fazer essa adaptação falando um pouquinho
• 1:40
  mais sobre o guia. É a primeira grande lição que
• 1:43
  esse guia nos ensina, né? Nos direciona.
• 1:46
  É a questão do tom de voz que a gente deve portar para falar com
• 1:50
  os nossos usuários. Ele destaca a questão da gente
• 1:54
  falar de uma forma relaxada e uma forma que vai mais direto ao
• 1:58
  ponto e assim pensa comigo. Quando a gente está travado numa
• 2:02
  demanda de software, numa atividade que seja a última
• 2:06
  coisa que a gente vai querer ler, é um texto enrolado.
• 2:09
  Então a Microsoft bate muito na tecla de fugir daquela voz
• 2:13
  passiva e robótica, por exemplo. Sabe quando a gente lê aquilo de
• 2:18
  a instalação de um determinado pacote deve ser feita pelo
• 2:22
  terminal. O guia.
• 2:24
  Ele te ensina a simplesmente dizer.
• 2:26
  Instale o pacote pelo terminal. É mais sobre a voz ativa, você
• 2:31
  diz exatamente o que a pessoa precisa fazer, cortando todo
• 2:35
  aquele ruído de uma voz passiva. Outro ponto que eu
• 2:39
  particularmente acho muito bacana desse guia é que ele
• 2:42
  serve como um aprendizado pra gente da área de uex, que é
• 2:46
  sobre as mensagens de erro. A regra de ouro dessas mensagens
• 2:51
  é nunca culpar o usuário pelo erro cometido, em vez da gente
• 2:56
  colocar assim na tela falha na inserção de dados do banco por
• 3:01
  erro de validação do usuário. A gente escreve simplesmente sua
• 3:06
  senha está incorreta. Vamos tentar tentar novamente.
• 3:09
  Você percebe a diferença, você tira todo aquele peso do erro e
• 3:14
  já foca na solução, criando assim uma ponte e não um beco
• 3:19
  Sem Saída. E assim, pessoal, já que estamos
• 3:22
  falando dessa dessa questão de interface de tela de o que é
• 3:26
  exibido para o usuário, o guia, ele traz algumas diretrizes
• 3:30
  sobre os famosos microcópios, que são aqueles textinhos de
• 3:34
  botões e menus. Sabe aquele botão genérico da
• 3:37
  aplicação, por exemplo, um ok que aparece numa caixa de alerta
• 3:41
  quando vai deletar alguma coisa? A Microsoft, ela disse pra gente
• 3:45
  não usar o botão ok. Ela evidencie ela.
• 3:50
  Ela deixa bem claro que a gente deva utilizar uma ação mais
• 3:54
  clara, por exemplo, o botão ele tem que de fato dizer excluir ou
• 3:59
  cancelar ou remover o usuário. Ele precisa bater o olho ali e
• 4:04
  saber exatamente o que vai acontecer se ele clicar ali sem
• 4:08
  precisar ler aquele parágrafo inteiro.
• 4:10
  Isso nos leva até a outro conceito essencial deles, que é
• 4:14
  a economia de palavras e a clareza na comunicação.
• 4:18
  O guia fala muito sobre não assumir que o usuário conheça
• 4:21
  todos os jargões técnicos e siglas da nossa bolha.
• 4:25
  Por exemplo, se você vai falar de DNS, de API, de deploy,
• 4:29
  explica o contexto para o seu público e não busque ser
• 4:32
  estritamente técnico. Assim, pessoal, além disso, a
• 4:36
  gente precisa também lembrar que a gente escreve muita das vezes
• 4:40
  para a internet. E a internet, ela é global, o
• 4:43
  Microsoft styleguide. Ele tem uma sessão inteira
• 4:46
  dedicada a escrever, pensando em tradução e localização.
• 4:50
  Por exemplo, se você usa expressões de idiomáticas,
• 4:53
  gírias muito complexas ou frases cheia de vírgulas, as
• 4:57
  ferramentas de tradução automática vão destruir destruir
• 5:01
  completamente o texto quando alguém de outro país tentar ler
• 5:04
  a sua documentação, a dica de ouro deles é usar frases curtas
• 5:09
  com a estrutura de sujeito, verbo e complemento.
• 5:12
  E é o simples que funciona. Junto com isso, vem o bater o
• 5:17
  olho e encontrar aquilo que a gente procura.
• 5:19
  Ninguém lê palavra por palavra, então use abuso de listas,
• 5:24
  coloque em negrito o que realmente importa e faça
• 5:27
  parágrafos curtos. Pra fechar com chave de ouro,
• 5:31
  eles trazem um capítulo no guia deles que é muito necessário,
• 5:35
  que é sobre linguagem inclusiva e Acessibilidade.
• 5:38
  É um lembrete para a gente evitar usar termos capacitistas
• 5:42
  ou antigos, que já não fazem muito sentido mais para nossa
• 5:45
  atualidade. Por exemplo, em vez de usar os
• 5:48
  termos blacklist e White list, o guia recomenda que a gente usa
• 5:53
  mais blocklist e hallow list, que são, né?
• 5:57
  Uma lista de permissões, uma lista de coisas que não são
• 6:00
  permitidas, que são termos muito mais literais, diretos e focados
• 6:05
  na ação real do sistema. No final das contas, a grande
• 6:08
  moral assim desse desse conteúdo é que o seu código ele pode ser
• 6:13
  incrível, sua arquitetura pode ser impecável, seus agentes de a
• 6:17
  podem ser muito descritivos. Porém, se a documentação, se a
• 6:23
  forma como você documenta como o usuário for ruim, o seu produto
• 6:26
  inteiro vai parecer ruim. Comunicação não é sobre
• 6:30
  perfumaria. Comunicação é código EOX.
• 6:34
  E é isso, pessoal. Fica aqui o meu convite, o meu
• 6:36
  desafio para vocês darem um Google, dar uma pesquisada sobre
• 6:40
  esse estilo de escrita da Microsoft.
• 6:43
  E é isso, pessoal, um grande abraço e até mais.