Projeto do WordPress

Esta página contém os detalhes de um projeto de redação técnica aceito para a Google Season of Docs.

Resumo do projeto

Organização de código aberto:
WordPress
Redator técnico:
dmivelli
(link em inglês)
Nome do projeto:
Melhorar a visibilidade de artigos na documentação do HelpHub do WordPress
Duração do projeto:
Duração padrão (três meses)

Project description

Resumo executivo

A popularidade do WordPress cresce a cada minuto. No início de julho de 2020, o WordPress 5.4 (a versão mais recente lançada em 21 de março de 2020) teve quase 51 milhões de downloads. O idioma mais usado é o inglês (71%), seguido pelo espanhol (4,7) e indonésio (2,4).

Uma boa documentação técnica é a base de qualquer sistema de ajuda. Redatores técnicos experientes criam conhecimento em conteúdo para os usuários. Os usuários querem realizar alguma ação que seja valiosa ou obrigatória no momento. Bons redatores técnicos entendem que a documentação bem escrita e precisa e a capacidade de se colocar no lugar do usuário são essenciais. No entanto, o que pode ser mais importante para um redator técnico, como a qualidade editorial e de produção, pode ser menos importante para os usuários do que a pontualidade e a capacidade de descoberta. Para que serve um tópico de ajuda bem escrito se o usuário não consegue encontrá-lo?

Desde o início, em 2003, o crescimento do WordPress no cenário de código aberto atraiu desenvolvedores, usuários e colaboradores. As categorias e tags de artigos originais precisam ser atualizadas e modernizadas para acompanhar o crescimento e as necessidades em constante mudança da comunidade do WordPress.

Quando o caminho dos usuários para a documentação solicitada é confuso ou interrompido, eles não conseguem encontrar o que precisam, perdem a confiança no produto e podem desistir dele.

Há uma solução. Confira a seguir algumas maneiras de melhorar a descoberta e apoiar o caminho do usuário até a documentação esperada:

  1. Decida e defina o estilo dos títulos das categorias
  2. Avaliar os títulos das categorias e garantir que elas abordem os tópicos corretamente (proponha atualizações, se necessário)
  3. Analisar os artigos e garantir que as categorizações estejam corretas
  4. Definir subcategorias para cada artigo
  5. Garantir que nenhum resultado da pesquisa oriente os usuários a acessar os fóruns de suporte
  6. Observe tópicos duplicados ou desatualizados para exclusão

A comunidade do WordPress fez um trabalho notável e compartilha as conquistas dos últimos 17 anos. Atualizar a categorização e garantir que a jornada do usuário seja precisa vai continuar impulsionando o crescimento, o sucesso e a fidelidade dos usuários que criam quase 70 milhões de novas postagens e 77 milhões de novos comentários a cada mês.

Introdução

O autor Joseph Campbell cunhou o termo A Jornada do Herói. Na ficção, refere-se ao conceito estrutural em que o protagonista viaja pelo mundo, enfrenta e supera desafios e retorna transformado.

No âmbito da documentação técnica, o usuário também embarca em uma jornada que o leva aos tópicos de ajuda com o objetivo de aprender, obter respostas e solucionar problemas. Quando o usuário consegue fazer isso, tudo fica bem. Quando os usuários não encontram respostas, eles ficam frustrados e desanimados.

Mas, por que isso acontece? Não é porque os redatores não se importam, não têm o conhecimento necessário ou estão com preguiça. Muitas vezes, o problema é que o redator técnico não considerou a jornada do usuário. Os redatores podem se concentrar na criação de um bom conteúdo, mas não considerar como o usuário vai acessar o tema. É fundamental se concentrar na jornada do usuário. Precisamos considerar o que eles querem saber e como eles querem chegar lá.

Conversei com a consultora do WordPress e designer de UX Estela Rueda, que contou um pouco da história. No momento, alguns títulos não descrevem corretamente o conteúdo do artigo. As categorias são usadas como tags e, como foram criadas há 15 anos, algumas estão desatualizadas. A inclusão de tags é inconsistente. Isso cria obstáculos para os usuários que procuram respostas.

Estado atual

O suporte do WordPress é dividido em nove categorias principais: Introdução, Instalação do WordPress, Uso básico, Administração básica, Personalização, Manutenção, Segurança, Tópicos avançados e Solução de problemas. Cada categoria contém várias subcategorias ou subtópicos que levam a artigos com a possibilidade de haver mais itens em cada página de destino.

Os benefícios de ter colaboradores do WordPress entusiasmados e colaborativos é que muitos tópicos estão disponíveis. No entanto, com muitas vozes e pontos de vista, as tags e categorias são inconsistentes.

Esses temas precisam ser modernizados para garantir que as categorias atendam às necessidades atuais dos usuários do WordPress. Com mais de 200 artigos, os problemas com tags e categorizações se tornaram relevantes.

Análise do plano

O objetivo principal é revisar e reclassificar os artigos para melhorar a capacidade de pesquisa. Sugiro as seguintes etapas:

  1. Trabalhar com a mentora Estela Rueda para consolidar o processo

    • Essa é uma etapa importante para garantir que os detalhes sejam confirmados e acordados.
    • De acordo com Estela, vamos acompanhar todas as atualizações propostas em uma planilha. A experiência de Estela mostrou que é melhor reunir e, em seguida, propor recomendações.

  2. Decidir e definir o estilo dos títulos de categoria

    • Sugiro uma estrutura uniforme e consistente para as categorias no tempo presente em vez do gerúndio (instalar vs. instalando), porque o gerúndio (-ing) pode criar dificuldades para os usuários de inglês como segunda língua (ESL) e o -ing não agrega valor ao usuário
    • Algumas categorias consistem em assuntos com uma e duas palavras (como Manutenção, Segurança, Administração básica) e outras são frases de gerúndio (Introdução ao WordPress, personalização). Faz sentido discutir como tornar a estrutura consistente
    • Tenho pesquisado como outras organizações configuram a ajuda on-line e vou discutir isso com meu mentor para saber o que pode ser útil.

  3. Avaliar os títulos das categorias (e propor atualizações)

    • Eles precisam ser reconhecíveis para o público-alvo do WordPress e atender às necessidades atuais.
    • Confirmar se eles são consistentes e aderem aos padrões do guia de estilo do WordPress
    • Os títulos precisam transmitir/explicar a intenção
    • Os títulos precisam esclarecer todas as ações de pré-requisito ou estados do usuário/dispositivo necessários

  4. Revisar artigos/tópicos

    • Os temas atendem com precisão às necessidades do público-alvo do WordPress?
    • Os temas têm o contexto correto ou fazem parte de uma sequência maior?
    • As etapas distinguem os vários atores na tarefa (usuário, sistema/dispositivo, quem faz o quê)?
    • Os atores são claramente diferenciados?
    • As etapas dividem processos complexos em partes úteis?

  5. Definir e marcar subcategorias

    • Consulte as histórias de usuário e continue adicionando à planilha para referência futura.
    • Continue adicionando à lista de subcategorias e detalhando o caminho delas

  6. Confira se nenhum resultado da pesquisa vincula os usuários aos fóruns de suporte

  7. Observar temas duplicados ou desatualizados para exclusão. Esse trabalho forense vai ajudar a informar e simplificar as jornadas do usuário.

Cronograma

Até 16 de agosto de 2020

  • Continuar consultando a documentação do WordPress
  • Familiarize-se com o estilo da documentação do WordPress
  • Pesquisar práticas recomendadas para jornadas do cliente em artigos de ajuda

17 de agosto a 13 de setembro

  • Conheça e trabalhe com Estela e a comunidade do WordPress
  • Colaborar com Estela para refinar as etapas do projeto e sugerir marcos para conclusão
  • Criar uma programação para incluir marcos e tarefas semanais
  • Definir a cadência de uma verificação de status com Estela (para resolver os obstáculos em tempo hábil)

De 14 de setembro a 30 de novembro

  • Início do projeto e trabalho de desenvolvimento com Estela/mentores

2 a 5 de dezembro

  • Enviar relatório final do produto do trabalho

De 3 a 10 de dezembro

  • Envie a avaliação de sucesso do projeto e a avaliação da experiência de trabalhar com os mentores e a equipe do WordPress

Conclusão

O WordPress é o sistema de gerenciamento de conteúdo (CMS) mais conhecido. De acordo com a W3techs, o WordPress é o CMS preferido para 37,7% dos sites, totalizando 63,6% do mercado de CMS (sistema de gerenciamento de conteúdo).

Com esse nível de popularidade, é essencial ter uma documentação precisa e fácil de seguir para conquistar o coração do usuário do WordPress.

Ao considerar a jornada do usuário e as perguntas que informam os possíveis caminhos, o WordPress pode modernizar as categorias de ajuda e a inclusão de tags para responder perguntas e resolver problemas. Dessa forma, o WordPress vai continuar atraindo clientes satisfeitos por muitos anos.