Como criar uma ligação estável no produto

Informações da Revisão
  • Id da revisão: 316615
  • Criado:
  • Criador: SuMo Bot
  • Comentário: No longer relevant.
  • Revisto: Sim
  • Revisto:
  • Revisto por: SumoBot
  • Está aprovado? Não
  • É a revisão atual? Não
  • Pronto para tradução: Não
Fonte da Revisão
Conteúdo da Revisão

Quando os engenheiros ou gestores de produto ligam a um artigo de suporte do SUMO a partir de um produto (como o Firefox), devem utilizar sempre um URL estável, e não a ligação direta do artigo. As ligações diretas mudam quando o título ou o slug do artigo é atualizado, o que pode quebrar as ligações no produto. As ligações estáveis protegem contra isto e garantem que os utilizadores chegam sempre à página certa.

Este artigo explica porque é que as ligações estáveis são importantes, como formatá-las para diferentes plataformas, e como configurar uma utilizando o painel do Kitsune.

Porque é que as ligações estáveis são importantes

Utilizar ligações diretas para os artigos de suporte (como https://support.mozilla.org/en-US/kb/example-article) pode levar a problemas:

  • Quebram-se facilmente: os URLs dos artigos mudam se o título mudar, a menos que o editor preserve manualmente o slug.
  • Não são localizáveis: as ligações diretas têm um idioma codificado, o que não é ideal para os utilizadores internacionais.
  • São mais difíceis de gerir: não as podemos atualizar globalmente se forem utilizadas diretamente no produto.

Em contrapartida, as ligações estáveis:

  • Mantêm-se consistentes, mesmo que o URL do artigo mude
  • Detetam automaticamente a localidade correta
  • Podem ser redirecionadas ou atualizadas centralmente, se necessário

Formato da ligação para artigos de suporte no produto

Utilize um formato padronizado para construir ligações de suporte estáveis para produtos de computador e móveis: 

https://support.mozilla.org/1/<product>/<version>/<os>/<locale>/<slug>

Notas:

  • %VERSION%, %OS%, e %LOCALE% são preenchidos automaticamente pelo produto.
  • Substitua <slug> pelo slug exclusivo que criar.

Este formato garante que os utilizadores são direcionados para o artigo localizado correto.

Exemplo:
https://support.mozilla.org/1/firefox/%VERSION%/%OS%/%LOCALE%/recommendations-firefox-new-tab

Como configurar uma ligação estável no produto em Kitsune

Para criar um redirecionamento estável, siga estes passos no painel de administração do Kitsune.

Tem de ser um administrador do Kitsune com as permissões certas para criar ligações estáveis.
  1. Inicie a sessão no painel de administração do Kitsune.
  2. Em INPRODUCT, clique em Redirects.
  3. Clique em Add Redirect no canto superior direito.
  4. Preencha os campos obrigatórios Product, Topic, e Target, conforme descrito na secção Campos de redirecionamento abaixo.
  5. Clique em SAVE.
  6. Partilhe a ligação estável concluída com o engenheiro ou gestor de produto, utilizando o formato no produto: 
https://support.mozilla.org/1/firefox/%VERSION%/%OS%/%LOCALE%/<slug>

Campos de redirecionamento

Campo Descrição
Product Utilize firefox para computador ou mobile para produtos móveis do Firefox.
Topic (slug)

Introduza um identificador curto e exclusivo para o artigo. Este torna-se parte da ligação estável.

  • Artigo novo? Crie um novo slug.
  • Artigo existente? Utilize o slug atual do artigo, se apropriado.
  • Utilize apenas letras minúsculas (a–z) e hífenes (-)
  • Não inclua caracteres especiais como #, sublinhados, ou espaços
  • O slug deve ser simples e descritivo, como: firefox-manage-account
Nota: o slug não tem de corresponder ao URL real do artigo de destino. Escolha algo significativo e consistente para a utilização do produto.
Target

O caminho para o artigo de suporte para o qual pretende redirecionar. Inclua apenas a parte a partir de kb/.

Exemplo: kb/firefox-lockwise-managing-account-data

Nota: pode incluir uma âncora (p. ex., kb/customize-items-on-firefox-new-tab-page#w_weather) para ligar a uma secção específica. As âncoras só funcionam na versão em inglês e podem não ser resolvidas noutras localidades.

Dicas

  • As ligações estáveis garantem a localização: os utilizadores serão automaticamente redirecionados para o seu idioma preferido quando disponível.
  • Pode atualizar ou apagar os redirecionamentos estáveis mais tarde através da interface de administração do Kitsune.
  • Utilize este método sempre que estiver a ligar a partir de:
    • Mensagens no produto "Saber mais"
    • Fluxos de integração
    • Mensagens de erro ou de aviso
    • Modais de ajuda contextual