Nossos Revisores da Base de Conhecimento são colaboradores e funcionários da Mozilla com experiência e habilidade em escrever documentação de suporte. Aqui estão algumas diretrizes para revisar artigos.

Propósito

Como revisor da Base de Conhecimento, seu papel é essencial para manter a precisão, clareza e consistência do conteúdo de suporte em nossa Base de Conhecimento. Seu trabalho de revisão garante que os usuários possam confiar em nossos artigos e encontrar ajuda facilmente.

Principais responsabilidades

Como revisor da BC, ao revisar uma revisão, sempre certifique-se de que a revisão:

• É precisa e atualizada
• Usa linguagem e tom claros e consistentes
• Está alinhada com as diretrizes editoriais da Mozilla
• Inclui formatação, links e marcação corretos e funcionais
• Segue as melhores práticas de acessibilidade e localização
• Atende ao escopo do artigo e à versão do produto

Diretrizes de revisão

A maioria das revisões são feitas por voluntários. Ao lidar com os trabalhos apresentados, assuma que todos têm boas intenções e não se esqueça de agradecer-lhes pela contribuição. Lembre-se, você pode ser o primeiro e o único contato que a pessoa tem com alguém da Mozilla. Por favor, faça-o positivo.

Política de revisão da Base de Conhecimento

Para atualizações importantes, é importante distinguir entre aprovação de conteúdo e revisão de conteúdo, pois são dois processos distintos.

• A aprovação de conteúdo é realizada pelas partes interessadas do produto, principalmente para validar a precisão técnica do conteúdo.
• A revisão de conteúdo é realizada pelos revisores da BC para garantir a qualidade editorial e a formatação do artigo.

Consulte Atribuições de contribuidores para solicitações de conteúdo para mais detalhes sobre essa distinção.

Quando a revisão da equipe é necessária?

A revisão da equipe é necessária para:

• Novos artigos
• Atualizações importantes explicitamente marcadas com “Revisão da equipe necessária” nas notas de revisão

Quando os colaboradores com permissões de revisão da BC podem revisar as revisões?

Colaboradores com permissões de revisão da BC podem revisar:

• Revisões classificadas como alterações menores
• Alterações importantes que não exigem revisão da equipe

Consulte Mudanças menores vs. maiores para saber mais sobre como as atualizações de conteúdo são classificadas com base em seu escopo e impacto.

Onde encontrar artigos não revisados

Existem várias maneiras de encontrar artigos não revisados:

• Visão geral da Base de Conhecimento: Esta página fornece uma lista de artigos em ordem de número de visualizações nos últimos 30 dias. A coluna Status mostrará quais artigos precisam de revisão. Você também pode filtrar com base no produto e no tipo de artigo.
• Alterações não revisadas: Esta página fornece uma maneira alternativa de ver quais artigos precisam de revisão, bem como há quanto tempo cada revisão está aguardando para ser revisada. Você pode optar por classificar com base em visualizações de página/alterações mais recentes e também pode filtrar com base no produto.
• Mais visitados: Esta página fornece uma lista de artigos da Base de Conhecimento com base no número de visualizações. Na coluna Status, você poderá ver quais artigos precisam de revisão.

Priorização

Ao revisar vários artigos, é importante priorizar seus esforços estrategicamente. Considere o seguinte:

• Artigo com muitas visualizações: Artigos com um alto número de visualizações devem ser priorizados para garantir que os usuários estejam acessando as informações mais precisas e atualizadas. Você pode identificá-los facilmente classificando a lista de Alterações não revisadas por contagem de visualizações.
• Artigo vinculado dentro do produto: Se você faz parte de um dos grupos de contribuição (Fórum, BC, L10n) ou do grupo “Equipe”, você pode ver um indicador mostrando que um artigo está vinculado dentro do produto. Esses artigos geralmente devem ter prioridade, pois têm um impacto direto na experiência do usuário.

  

Artigos especiais

• Modelos incluem conteúdo que é reutilizado em vários artigos e devem ser considerados como alta prioridade devido ao seu impacto mais amplo. Todos os modelos, incluindo aqueles que precisam de revisão, estão listados neste quadro. Para obter diretrizes sobre como usar modelos em artigos, consulte Usando modelos.
• Respostas prontas são respostas padronizadas usadas nos Fóruns da Comunidade. Como são reutilizadas com frequência, quaisquer atualizações devem ser coordenadas com a equipe da Comunidade. Uma lista de todas as respostas do fórum, incluindo aquelas que precisam de revisão, está disponível neste outro quadro. Para obter diretrizes adicionais sobre como criar ou melhorar respostas comuns, consulte Criar ou melhorar respostas comuns de fórum.

Requisitos especiais para produtos de assinatura ou premium

Envio de conteúdo

Se você quiser sugerir novo conteúdo ou propor alterações, por favor, abra um tíquete no Bugzilla ou entre em contato com um membro da equipe. Você pode nos contatar no Matrix ou no canal #sumo-team no Slack (para colaboradores com acesso ao Slack).

Revisão e aprovação de revisão da BC

A aprovação da equipe é necessária para todas as revisões relacionadas a produtos de Assinatura ou Premium. Isso inclui Respostas Prontas e Modelos associados a esses produtos.

Para referência, os produtos de Assinatura ou Premium atuais incluem:

• Mozilla VPN
• Firefox Relay
• Mozilla Monitor
• MDN Plus

Revisando artigos

Escolhendo os níveis de revisão

Quando você aprova um artigo, você tem três níveis de revisão diferentes para escolher. Esses níveis determinarão a necessidade e a priorização para a localização.

• Pequenos detalhes que não afetam as instruções: Estas são mudanças que não mudarão as instruções para os usuários. Os localizadores não serão notificados sobre estas mudanças.
• Alterações de conteúdo que não necessitam de tradução imediata: Esta é a opção padrão. Estas são mudanças importantes (atualizações e grandes mudanças) que não invalidam completamente a versão anterior do artigo. Os localizadores não serão notificados imediatamente sobre as alterações, mas a revisão pode ser marcada como Pronta para Localização mais tarde e isso acionará a notificação para os localizadores.
• Grandes mudanças de conteúdo que vão tornar traduções mais antigas imprecisas: Isso pode ser usado quando a atualização fará com que o conteúdo anterior fique desatualizado. Marcar um artigo com isso acionará um aviso nos artigos localizados de que o conteúdo pode estar desatualizado e fornecerá um link para a versão em inglês para as informações mais atualizadas.

  

Deixando feedback para os editores

Ao aprovar um artigo, é importante agradecer aos editores por sua contribuição. Também é bom se você puder dar um feedback a eles. A escrita deles melhorou? Eles fizeram um trabalho especialmente bom explicando algo complexo? Diga a eles!

Adiando uma revisão

Se uma revisão não for particularmente útil, você pode adiar a revisão proposta. Em vez de ser uma simples rejeição, no entanto, um adiamento é sua oportunidade de trabalhar com o autor da revisão para melhorá-la. Você pode fazer isso deixando uma mensagem no campo de comentário para agradecer ao autor e, em seguida, dar um feedback específico e construtivo sobre o que você acha que precisa mudar para que a revisão seja aceitável. Certifique-se de incluir também links para quaisquer documentações ou diretrizes relevantes.

Revisando múltiplas revisões

Quando houver várias revisões pendentes de aprovação, certifique-se de verificar todas as revisões, começando pela mais antiga, antes de tomar uma decisão. É importante notar que você não pode revisar revisões mais antigas quando uma revisão mais recente foi aprovada. Você verá que elas ainda estão pendentes de aprovação, mas não será possível revisá-las.

Necessita de mudança

Ao aprovar uma revisão, você tem que decidir se alguma coisa ainda precisa ser mudada. Se tudo especificado no comentário “Necessita de mudança” foi resolvido, você pode desmarcá-lo (limpando o comentário) e aprovar o artigo. Se ainda há coisas que precisam ser feitas, certifique-se de que a caixa de seleção esteja marcada e atualize o comentário. Desta forma, podemos acompanhar facilmente o trabalho que precisa ser feito nos artigos.

Dando crédito

Às vezes, pessoas que participam de uma discussão sobre um artigo fazem contribuições significativas para uma revisão, mesmo que não tenham sido elas a editar o wiki. Em casos como este, você pode editar a lista de contribuidores de um artigo (na página de histórico do artigo) para incluí-los. Pontos de bônus por avisá-los que você fez isso!

Como dar crédito a um colaborador na BC

• Para adicionar um contribuidor, vá para a página Mostrar histórico de um artigo
• Role para baixo sob as revisões e clique no link Editar contribuidores
• Digite o nome do contribuidor e clique em Add Contributor

Lidando com spam e edições equivocadas

No caso de spam, você deve simplesmente excluir a revisão clicando no ícone da lixeira no histórico de revisão do artigo e confirmando. No caso de envios equivocados (sem alterações) e pedidos de ajuda fora do lugar (a edição é basicamente uma pergunta de suporte), você deve adiar e incluir esta mensagem em seus comentários:
Oi.
Parece que você pode ter tentado obter ajuda com o Firefox. Se for o caso, por favor, faça sua pergunta novamente aqui, https://support.mozilla.org/questions/new para que possamos ajudá-lo melhor.
Desculpe pelo inconveniente.

Depois de fazer isso, você pode excluir a revisão.

Pronto para localização

Como funciona o “Pronto para Localização” (RFL)?

Para evitar que os colaboradores traduzam um artigo que ainda está sendo atualizado, o sistema só permite a tradução de versões que foram explicitamente marcadas como Pronto para Localização (RFL). Quando o localizador clica em Translate article, ele recebe a revisão mais recente que foi marcada como RFL.

Após a aprovação de uma nova revisão, o artigo não aparecerá nos painéis de localização como necessitando de uma atualização, a menos que a sinalização Pronto para Localização (RFL) esteja marcada. Quando a sinalização RFL é definida, o sistema também envia uma notificação por e-mail para todos que estão observando o artigo, informando que o artigo está pronto para ser localizado.

Marcando um artigo como RFL

Marcar uma revisão de artigo como “Pronto para localização” significa que estamos dizendo aos localizadores que a versão em inglês está pronta e pode ser traduzida sem medo de que o artigo mude mais algumas vezes antes de terminarem.

A localização é muito trabalhosa e muitas vezes é feita por apenas uma pessoa. Nem sempre é fácil, mas tente garantir que todas as alterações necessárias sejam feitas antes do lançamento de uma versão do Firefox, para que os localizadores possam usar esse tempo extra para concluir seu trabalho.

Marcando um artigo como RFL pós-revisão

Se você não estiver marcando uma revisão como pronta para localização ao aprová-la (como no caso acima), você pode marcá-la como pronta a qualquer momento clicando na entrada de status “Não pronto para localização” (um símbolo ✕) na coluna R do histórico de revisão do artigo e confirmando.

Revisões que foram marcadas como RFL têm um símbolo de marca de seleção ✓.

Protocolos RFL

Todos os revisores colaboradores devem aderir aos seguintes protocolos de localização:

• Todos os funcionários da Mozilla e revisores colaboradores podem marcar um artigo novo ou uma atualização de artigo como pronto para localização.
• Todos os artigos novos e revisões que introduzem informações novas ou alteradas devem ser marcados para localização, a menos que especificado de outra forma pelas equipes de Produto com base na disponibilidade regional.
• Se uma revisão não alterar a instrução, precisão ou experiência do usuário, a prioridade de localização deve ser diminuída de acordo.
• Em alguns casos, a equipe da Mozilla pode deixar uma sintaxe de comentário ou um comentário de revisão em um artigo para indicar que uma tradução já está sendo enviada para localização interna em certas localidades. Se a sintaxe de comentário indicar que um artigo ou revisão já está sendo enviado para localização interna, os colaboradores não devem localizá-lo de forma independente.

Prontidão para lançamento

Para garantir que estamos prontos para dar suporte aos próximos lançamentos do Firefox, aqui estão algumas diretrizes sobre os cronogramas de prontidão para lançamento. Artigos associados ao próximo lançamento são novos artigos ou atualizações de conteúdo que cobrem funcionalidades introduzidas no próximo lançamento. As seguintes diretrizes se aplicam a artigos com conteúdo relacionado ao lançamento.

Calendário de lançamentos do Firefox

4 semanas antes do próximo lançamento

• Começar a planejar e redigir o conteúdo para o próximo lançamento; ainda não há trabalho para os localizadores.
• Todos os artigos existentes permanecem abertos para edição e localização como de costume.

1-2 semanas antes do próximo lançamento

• O rascunho do conteúdo para o próximo lançamento pode estar pronto internamente; no entanto, a publicação geralmente aguarda até a data de lançamento oficial para levar em conta quaisquer alterações de última hora.
• Se o conteúdo exigir localização antes do lançamento, a equipe do produto deve notificar a equipe de CX para que possamos coordenar com a comunidade de localização para garantir que os prazos sejam cumpridos.

Dia do lançamento

• As alterações de conteúdo devem ser publicadas na Base de Conhecimento em en-US. Os localizadores devem priorizar a tradução de artigos relacionados ao novo lançamento.

Canal de discussão e escalonamento

Nem todos os revisores da BC monitoram ativamente as Discussões da BC. Se você precisar entrar em contato com todo o grupo de revisores da BC, envie um e-mail para kb-reviewers@mozilla.com.

Avaliação do papel

Criar conteúdo preciso, consistente e relevante é importante, e manter essa qualidade ao longo do tempo requer um padrão compartilhado e alinhamento contínuo.

Como revisor da Base de Conhecimento, você desempenha um papel importante na manutenção desses padrões. Para garantir que nosso grupo de revisores permaneça ativo e alinhado com as práticas atuais, a equipe da Comunidade realiza uma leve revisão anual com base na participação e adesão às diretrizes.

Para manter sua permissão de revisor da BC, pedimos que você:

• Mantenha-se alinhado: Adira às Diretrizes de Participação da Comunidade e às diretrizes de revisor da BC descritas neste artigo.
• Mantenha-se ativo: Revise pelo menos três (3) revisões dentro de um período de seis meses.

Se você não esteve ativo ou se surgirem dúvidas sobre a adesão às diretrizes, a equipe da Comunidade pode entrar em contato com você para verificar antes de tomar qualquer medida. Nosso objetivo não é remover permissões, mas garantir que os revisores se sintam engajados, apoiados e alinhados com os processos atuais.

Se as circunstâncias mudarem e você precisar se afastar, entendemos perfeitamente. Como este é um papel voluntário, seu tempo e disponibilidade podem mudar naturalmente. Não hesite em informar a equipe da Comunidade quando isso acontecer. Estamos sempre felizes em nos reconectar quando você estiver pronto para se engajar novamente.

—

Ao trabalharmos juntos e envolvermos outras pessoas no processo de revisão e aprovação, podemos manter os mais altos padrões de qualidade e garantir que nosso conteúdo seja de primeira linha. Obrigado por sua cooperação e vamos continuar a criar revisões incríveis para nossos usuários!