Saiba mais sobre a Base de Conhecimento do Suporte Mozilla (SUMO) e como ela funciona.

O que é a Base de Conhecimento?

A Base de Conhecimento é um wiki com superpoderes:

• Marcação wiki especial – Embora usemos marcação MediaWiki (como a Wikipedia) para a maioria das coisas, nosso wiki é projetado especificamente para o Suporte Mozilla e usa algumas marcações personalizadas (chamadas de {for}) para que possamos mostrar um conjunto de instruções para usuários do Windows, por exemplo, e outro para usuários de Mac.
• Sistema de revisão – Como queremos ter certeza de que as pessoas obtenham informações corretas e atualizadas, as edições em nossos artigos precisam ser revisadas e aprovadas antes de serem publicadas.
• Traduções – A maioria de nossos usuários fala um idioma diferente do inglês. Temos todo um sistema para traduzir os artigos em inglês de nossa Base de Conhecimento para outros idiomas.

Público e escopo da Base de Conhecimento

Como os produtos da Mozilla são usados por milhões de pessoas de todos os níveis de habilidade, a Base de Conhecimento deve ser escrita para um público geral, em vez de um que seja muito familiarizado com técnicas e terminologia de informática. Cobrimos principalmente recursos (como abas, favoritos e Sync) e a solução de problemas (como travamentos ou problemas ao carregar sites). Não cobrimos todos os recursos, configurações ou problemas. Em vez disso, observamos o que os usuários nos dizem (em discussões de artigos, fóruns de suporte, visualizações de artigos) e usamos nossa experiência e julgamento para decidir exatamente o que cobrir.

Quais tópicos não cobrimos na Base de Conhecimento?

• Truques ou hacks para modificar um produto, como configuração de preferência avançada (about:config)
• Recursos avançados e de desenvolvedor, como o Console Web

Organizando nosso trabalho

Como priorizamos em que trabalhamos?

Trabalhamos principalmente em artigos por ordem de popularidade. Isso geralmente representa as prioridades de nossos usuários. Atualmente, os 20 artigos mais visitados respondem por mais da metade de todas as visualizações. Tornar nosso artigo principal mais útil pode ajudar tantas pessoas quanto melhorar os 100 artigos de baixo. Acompanhamos as alterações que precisam ser feitas em este painel. Ele é classificado pela posição do artigo para que você possa ver facilmente no que se deve trabalhar primeiro.

Exceções:
Claro, a popularidade não é a única prioridade. Essas exceções também precisam ser levadas em consideração.

• Problemas críticos – Ocasionalmente, novos problemas são relatados em nosso fórum de suporte que são mais bem resolvidos com a atualização de um artigo da Base de Conhecimento.
• Demanda antecipada – Ocasionalmente, atualizamos um artigo em antecipação a um novo recurso ou alteração de recurso. O artigo atual pode não ter uma classificação particularmente alta, mas temos certeza razoável, com base na experiência e nos planos de marketing, de que esses artigos se tornarão populares.
• Documentação móvel – Como os produtos da Mozilla para dispositivos móveis, como o Firefox for Android e o Firefox for iOS, têm comparativamente poucos usuários, não se pode esperar que seus artigos “concorram” com os artigos do Firefox para desktop. Os artigos para esses produtos devem ser considerados no contexto da demanda relativa por documentação de recursos e problemas relacionados ao produto individual.
• Artigos vinculados – São artigos vinculados de dentro dos produtos ou do mozilla.org.

Prioridade no desktop

1. Windows – Com cerca de 90% de nossos usuários no Windows, esta é a escolha óbvia. Por enquanto, devemos fazer capturas de tela para o Windows (de preferência o Windows 10) se você só puder fazer uma.
2. Mac – A versão atual (macOS 15.0 Sequoia em setembro de 2024)
3. Linux – Use o Ubuntu para capturas de tela.

Dispositivos móveis

• Android – 4.0 + (4.0, 4.1, 4.2, 4.3, etc.).

Onde discutimos sobre os artigos?

Geralmente temos dois tipos de conversas sobre os artigos da base de conhecimento:

• Artigos individuais – Cada artigo tem seu próprio fórum de discussão, acessível em Ferramentas de edição.
  
  Usuários registrados podem postar comentários sobre os artigos aqui, e podemos discutir quais revisões o artigo precisa, os méritos relativos das revisões e questões relacionadas ao artigo.
• A Base de Conhecimento como um todo – Discutimos ideias e questões com a estratégia geral da BC, políticas e software no fórum de discussões da Base de Conhecimento.

Como fico por dentro do que está acontecendo?

• Suporte Mozilla (SUMO) blog: As últimas atualizações e desenvolvimentos do projeto são discutidos aqui.
• Informações e recursos: Esta é outra boa fonte de informação – é atualizada mais ou menos toda semana.
• discussões da comunidade SUMO: É aqui que os colaboradores conversam entre si.
• discussões da BC: Este é o lugar onde discutimos tópicos gerais sobre a BC.
• discussões de localização: Este é o lugar onde falamos sobre a localização do SUMO.

Adicionando e removendo artigos

Propondo novos artigos

Nossa base de conhecimento é o que faz todo o nosso esforço de suporte escalar para atender centenas de milhões de usuários do Firefox. A coisa mais eficiente que podemos fazer é responder às perguntas das pessoas sobre os produtos e serviços da Mozilla com um artigo. Mas os artigos têm um custo. Cada um tem que ser escrito, localizado e mantido. Com muitos recursos e problemas já documentados, geralmente é um uso melhor do nosso tempo coletivo para melhorar os artigos existentes. Antes de começar a criar novos artigos, vamos analisar algumas coisas que você deve considerar primeiro:

Nós realmente precisamos deste artigo?
Estas são as principais razões pelas quais adicionamos um novo artigo à Base de Conhecimento, embora muitas vezes faça mais sentido atualizar ou adicionar a um artigo existente.

• Novos recursos – Recursos voltados para o usuário que provavelmente gerarão muito interesse e perguntas dos usuários. Isso pode ser um aspecto inerente do recurso, um resultado de marketing e links no produto ou uma combinação dos dois.
• Novos problemas – Problemas que têm muitos tópicos e votos recentes no fórum de suporte.
• Alto impacto – Problemas críticos e urgentes que precisam de documentação temporária (por exemplo, Firefox startup crash with G DATA security software).

Arquivando artigos

Para garantir que nossa Base de Conhecimento permaneça focada nas dúvidas mais atuais e urgentes dos usuários, revisamos e arquivamos periodicamente os artigos que não refletem mais as versões mais recentes dos produtos ou serviços da Mozilla ou as preocupações dos usuários. Arquivar não é o fim de um artigo; é uma forma de sinalizar que o conteúdo pode estar desatualizado ou menos relevante para nossa base de usuários atual, preservando seu valor histórico e o acesso para quem possa precisar.

Como funciona

A equipe e os colaboradores com privilégios de revisor podem marcar um artigo como obsoleto. Isso é feito editando a página de descrição do artigo, acessível através da opção Editar metadados do artigo em Ferramentas de edição. Um artigo arquivado é removido de todos os painéis, incluindo os de localização, e não aparecerá nos resultados de pesquisa normais. No entanto, quaisquer links diretos existentes para o artigo ainda funcionarão. Um aviso será exibido no topo do artigo para informar aos leitores que ele não está mais sendo mantido e pode estar desatualizado. O arquivamento é reversível. Se necessário, os colaboradores podem revisitar a página Edit Article Metadata e desmarcar a opção Obsoleto, trazendo o artigo de volta ao status ativo.

Considerações antes de arquivar

• Poucas visualizações: Artigos que atraem menos de 1500 visitas por mês são candidatos a arquivamento.
• Poucos relatos recentes: A falta de tópicos ou votos recentes no fórum de suporte sugere que o artigo aborda uma preocupação menor.
• Baixo impacto: Artigos cuja remoção provavelmente não causará problemas significativos.

Alterações no produto: Artigos relacionados a problemas que foram resolvidos ou recursos que mudaram significativamente.

Diretrizes para arquivar artigos da BC

Ao decidir arquivar um artigo, considere o seguinte para garantir que a decisão esteja alinhada com os melhores interesses de nossa base de usuários e a precisão de nossa Base de Conhecimento:

• Obsolescência e irrelevância: Os artigos devem ser arquivados se o conteúdo não for mais relevante para as versões atuais dos produtos ou serviços da Mozilla. Para mais detalhes, consulte a política de suporte de versão do Firefox para o conteúdo da Base de Conhecimento.
• Redundância: Conteúdo que foi substituído por artigos mais abrangentes ou duplicado em vários artigos sem adicionar valor único deve ser arquivado para otimizar a base de conhecimento.
• Conteúdo histórico: Artigos que servem mais como um registro histórico do que como suporte prático e atual podem ser arquivados para manter a base de conhecimento ativa focada no suporte ao usuário.

Restringir visibilidade

O recurso Restringir Visibilidade é uma adição recente que visa aumentar a flexibilidade do gerenciamento de conteúdo na plataforma SUMO. Esse recurso permite que artigos específicos sejam visíveis apenas para grupos designados, como membros da equipe ou certos colaboradores, permitindo a distribuição de conteúdo sensível ou em estágio inicial de forma controlada.

Como funciona

Restringir a visibilidade capacita a equipe e os colaboradores com privilégios de revisor a gerenciar a acessibilidade de artigos para públicos específicos. Esse recurso é importante para controlar a disseminação de informações sensíveis ou em estágio inicial que ainda não se destinam ao público em geral. Veja como funciona:

• Definindo restrições: Um membro da equipe ou colaborador com os privilégios necessários pode restringir a visibilidade de um artigo. Isso é feito navegando até a página de Descrição do artigo e selecionando as configurações de visibilidade apropriadas na seção "Editar metadados do artigo" encontrada em Ferramentas de edição.
• Impacto da restrição: Uma vez que um artigo é definido com visibilidade restrita, ele se torna inacessível ao público em geral e visível apenas para membros da equipe e grupos designados (como círculos de colaboradores específicos, colaboradores sob NDA, etc.). Essa ação remove o artigo dos resultados de pesquisa gerais e dos painéis públicos, embora os links diretos para o artigo permaneçam funcionais para quem tem acesso.
• Indicadores de visibilidade: Artigos com visibilidade restrita apresentarão indicadores ou avisos para esclarecer seu status aos espectadores que têm acesso. Isso os alerta de que o conteúdo é restrito e pode conter informações ainda não públicas ou destinadas a um público específico.
• Reversibilidade e ajuste: A configuração de visibilidade restrita não é permanente e pode ser ajustada conforme a necessidade de restrição muda. A equipe e os colaboradores com os privilégios apropriados podem retornar às configurações de metadados do artigo para modificar as restrições de visibilidade, tornando o artigo disponível para um público mais amplo ou ajustando os grupos que têm acesso.

Considerações antes de restringir a visibilidade:

Antes de aplicar o recurso Restringir Visibilidade a um artigo, é crucial ponderar o seguinte para garantir que o recurso seja usado de forma eficaz:

• Necessidade do público: Certifique-se de que o conteúdo se destina de fato a um público específico e não é benéfico para a base de usuários mais ampla.
• Sensibilidade do conteúdo: Avalie a sensibilidade da informação para determinar se a visibilidade restrita é justificada.
• Impacto no suporte do fórum: Considere se restringir a visibilidade do artigo pode impactar negativamente os usuários que poderiam se beneficiar da informação e, em caso afirmativo, procure métodos alternativos para resolver quaisquer preocupações.
• Relevância temporal: Para conteúdo que é apenas temporariamente sensível (por exemplo, recursos sob embargo até uma determinada data), planeje ajustar as configurações de visibilidade assim que a informação não for mais restrita.

Diretrizes para restringir a visibilidade:

• Conteúdo de pré-lançamento: Ideal para artigos que detalham recursos ou produtos futuros que ainda não são públicos.
• Comunicação direcionada: Permite o compartilhamento de informações com grupos específicos dentro de nossa comunidade, como colaboradores sob NDA ou líderes de localidade, sem tornar o conteúdo público.
• Gerenciamento de informações sensíveis: Útil para conteúdo que, devido à sua natureza sensível, requer acesso restrito.

Diretrizes de revisão de artigos

Para saber mais sobre as diretrizes para revisar artigos da Base de Conhecimento, consulte Diretrizes para revisão de artigos.

Diretrizes completas da Base de Conhecimento

Se você está realmente interessado em editar e escrever documentação, aqui estão alguns recursos que devem ajudar a explicar como fazemos as coisas:

Criar novos artigos de suporte

• Como escrever artigos para a base de conhecimento — Guia de técnicas e estilos de escrita que usamos para tornar os artigos mais envolventes e eficazes. Para a mecânica de criar ou editar artigos, consulte:
  • Crie um novo artigo da Base de conhecimento – Passos para criar um novo artigo, juntamente com alguns exemplos de marcação wiki para você começar.
  • Anatomia de um artigo da Base de Conhecimento – Explica o básico de como os artigos são construídos.
  • Article Description – Explica como escrever a descrição de um artigo de suporte.

Melhorar artigos de suporte existentes

• Melhorando a base de conhecimento – Saiba como melhorar a Base de Conhecimento do SUMO.
• Edit a Knowledge Base article – Passos para editar um artigo existente.

Outras diretrizes

• Como funciona a Base de Conhecimento — Uma visão geral da mecânica da nossa Base de Conhecimento (Você está aqui!)
• Como fazer capturas de tela — Um guia passo a passo para criar capturas de tela para usar em artigos.
• Diretrizes para revisão de artigos – Diretrizes para revisores da Base de Conhecimento.
• Como inserir imagens em um artigo — Explica como adicionar capturas de tela aos artigos e exibi-las corretamente.
• Marcações mais usadas – A marcação wiki mais comumente usada em nossos artigos.
• Tabela de marcação — Referência de marcação wiki. Dá exemplos e mostra a marcação que os produz.
• Como usar {for} — Marcação wiki especial que nos permite mostrar instruções para diferentes versões de aplicativos (por exemplo, Firefox 115) e sistemas operacionais como Windows e macOS.
• Como usar Templates — Modelos são pedaços de conteúdo reutilizáveis. Você pode incluir um conjunto complicado de instruções passo a passo em vários artigos usando um modelo.
• Quando e como usar palavras-chave para melhorar a classificação de um artigo na busca — Explica quando é apropriado adicionar palavras-chave a um artigo.
• Veja mais diretrizes sobre contribuição na Base de Conhecimento aqui.