Projeto do WordPress

Esta página contém os detalhes de um projeto de escrita técnica aceito para a temporada de documentos do Google.

Resumo do projeto

Organização de código aberto:
WordPress
Redator técnico:
dmivelli
(em inglês)
Nome do projeto:
Melhorar a detecção de artigos na documentação do HelpHub do WordPress
Duração do projeto:
Duração padrão (3 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 do espanhol (4,7) e do indonésio (2,4).

Uma boa documentação técnica é a espinha dorsal de qualquer sistema de ajuda. Escritores técnicos experientes criam conhecimento para o conteúdo para os usuários. Os usuários querem realizar alguma ação valiosa ou necessária naquele momento. Os bons redatores técnicos entendem que uma documentação bem escrita e precisa e a capacidade de se colocar na mente 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 oportunidade e a facilidade de descoberta. Para que serve um tópico de ajuda muito bem escrito se o usuário não conseguir encontrá-lo?

Desde seu início em 2003, o crescimento do WordPress na área de código aberto tem atraído desenvolvedores, usuários e colaboradores. As categorias e tags originais de artigos precisam ser atualizadas e modernizadas para acompanhar o crescimento e as mudanças nas necessidades da comunidade do WordPress.

Quando os caminhos dos usuários até a documentação solicitada são confusos ou interrompidos, eles falham na pesquisa, perdem a confiança no produto e podem abandoná-lo completamente.

Existe uma solução. Confira a seguir maneiras de melhorar a detecção e oferecer suporte ao caminho do usuário até a documentação esperada:

  1. Decida e defina o estilo dos títulos das categorias
  2. Avalie os títulos das categorias e verifique se eles abordam corretamente os tópicos (proponha atualizações, se necessário)
  3. Revise os artigos e verifique se as categorizações estão corretas.
  4. Definir subcategorias para cada artigo
  5. Garantir que nenhum resultado de pesquisa direcione os usuários para os fóruns de suporte
  6. Observe tópicos duplicados ou desatualizados para exclusão

A comunidade do WordPress realizou um trabalho notável e compartilha as conquistas dos últimos 17 anos. Para atualizar a categorização e garantir que a jornada do usuário seja precisa, vamos 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 por mês.

Introdução

O autor Joseph Campbell cunhou o termo, a Jornada do Herói. Na ficção, é o conceito estrutural em que a protagonista viaja pelo mundo, enfrenta e supera desafios, e os retornos transformados.

Na 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, encontrar respostas e solucionar problemas. Quando o usuário consegue fazer isso, tudo fica bem para ele. Quando os usuários não conseguem encontrar respostas, eles saem frustrados e desanimados.

Mas por que isso acontece? Não é porque os roteiristas cortaram custos, não se importam ou não têm o conhecimento. Muitas vezes, é que o redator técnico não considerou a jornada do usuário. Os autores podem mergulhar na criação de bom conteúdo, mas não considerar como o usuário acessará o tópico. É essencial focar na jornada do usuário. Precisamos considerar o que eles querem saber e como querem chegar lá.

Conversei com a consultora do WordPress e a designer de UX Estela Rueda, que conta um pouco da sua 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, Solução de Problemas). Cada categoria contém várias subcategorias ou subtópicos que levam a artigos com a possibilidade de mais em cada página de destino.

O benefício de ter colaboradores entusiasmados e colaborativos do WordPress é que há muitos tópicos disponíveis. No entanto, com muitas vozes e pontos de vista, a inclusão de tags e as categorias são inconsistentes.

Esses tópicos 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 as matérias para melhorar a capacidade de pesquisa. Proponho as seguintes etapas:

  1. Trabalhar com a Mentor Estela Rueda para solidificar o processo

    • Esta é uma etapa importante para garantir que os detalhes sejam confirmados e acordados
    • Conforme estela, vamos acompanhar todas as atualizações propostas em uma planilha (a experiência de Estela mostrou que é melhor coletar e propor recomendações)

  2. Decida e defina o estilo dos títulos das categorias

    • Sugiro uma estrutura uniforme e consistente para as categorias no presente, e não na forma do gerúndio (instalação x instalação), já que a forma do gerúndio (-ing) pode criar dificuldades para usuários de inglês como Segunda língua (ESL), e o -ing não agrega valor ao usuário
    • Algumas categorias são assuntos com uma ou duas palavras (como Manutenção, Segurança, Administração básica) e outras são frases em gerúndio (Introdução ao WordPress, Personalização). Faz sentido discutir como tornar a estrutura consistente
    • Pesquisei 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 títulos de categorias (e propor atualizações)

    • Eles devem ser reconhecidos pela perspectiva do público-alvo do WordPress e atender às necessidades atuais.
    • Confirmar se eles são consistentes e seguem os padrões do Guia de estilo do WordPress
    • Garantir que os títulos transmitam/explicam 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/assuntos

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

  5. Definir e marcar subcategorias

    • Consultar as histórias de usuários e continuar adicionando à planilha para referência futura
    • Continue adicionando itens à lista de subcategorias e detalhando o caminho delas

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

  7. Observe tópicos duplicados ou desatualizados para exclusão. Esse trabalho forense ajudará a informar e simplificar as jornadas do usuário

Cronograma

Até 16 de agosto de 2020

  • Continuar revisando a documentação do WordPress
  • Conhecer melhor o estilo de documentação do WordPress
  • Pesquisar em tópicos de ajuda as práticas recomendadas para a jornada do cliente

17 de agosto a 13 de setembro

  • Conheça e trabalhe com a Estela e a comunidade do WordPress
  • Colaborar com a Estela para refinar as etapas do projeto e sugerir marcos para a conclusão
  • Crie um cronograma para incluir marcos e tarefas semanais
  • Defina uma cadência para uma verificação de status com Estela (para lidar com bloqueadores em tempo hábil)

14 de setembro a 30 de novembro

  • Trabalho inicial e desenvolvimento do projeto com Estela/mentors

2 a 5 de dezembro

  • Enviar relatório final do produto

3 a 10 de dezembro

  • Enviar uma avaliação de sucesso do projeto e de experiência de trabalho 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 é a escolha de CMS para 37,7% de todos os sites, o que dá a ele 63,6% da participação de mercado de CMSs.

Com esse grau de popularidade, uma documentação precisa e fácil de seguir é essencial 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 do usuário, o WordPress pode modernizar as categorias de ajuda e a inclusão de tags para responder a perguntas de maneira eficaz e resolver problemas. Dessa forma, o WordPress continuará atraindo clientes satisfeitos nos próximos anos.