Como funciona a Base de Conhecimento

Ok. Esta é a versão longa de como as coisas funcionam. Você pode querer obter alguns petiscos ou algo parecido, antes de começar. Até mesmo o índice é longo.

A Base de Conhecimento é um wiki com super poderes

Veja isto:

  • Marcação especial wiki - Apesar de usarmos marcação MediaWiki (como a Wikipedia) para a maioria das coisas, a nossa wiki é projetada especificamente para o Suporte Mozilla e usa algumas marcações personalizadas (chamado {for}) para que possamos exibir um conjunto de instruções para usuários do Windows, por exemplo, e outro bem diferente para usuários de Mac.
  • Sistema de revisão - Porque queremos ter certeza de que as pessoas tenham informações corretas e atualizadas, as edições dos nossos artigos têm de ser analisadas e aprovadas antes de se tornarem ativas.
  • Traduções - A maioria dos nossos usuários, falam uma língua diferente do Inglês. Portanto, temos todo um sistema para traduzir os artigos em inglês de nossa Base de Conhecimento para outros idiomas.

Audiência & escopo da Base de Conhecimento

Com mais de 400 milhões de usuários Firefox, a base de conhecimento tem de ser escrito para o público em geral, ao invés de um universo muito familiarizado com as técnicas e terminologias de informática. Estamos principalmente cobrindo características (como abas, favoritos e sincronização) e corrigindo problemas (como falhas ou problemas de carregamento de websites). Nós não cobrimos todos os recursos, configuração ou problema. Como alternativa olhamos o que os usuários nos dizem (em artigo de discussões, fóruns de suporte, artigos de ponto de vista) e usamos a nossa experiência e bom senso para decidir exatamente o que cobrir.

Que temas não estão contidos na Base de Conhecimento?

  • Truques ou hacks para modificar um produto
  • Recursos avançados e reveladores como o console de erros ou console web
Nota: Artigos de solução de problemas muitas vezes são a exceção a essas regras. Se um problema comum só pode ser corrigido com um "hack," nós iremos documentar isso.

Organizando o nosso trabalho

Como é que vamos priorizar o que trabalhar?

Estamos trabalhando sobretudo em artigos em ordem de popularidade. Isso geralmente representa as prioridades dos nossos usuários. Atualmente, os top 20 articles são os responsáveis por mais da metade de todas as visualizações. Fazendo nosso artigo "top" mais utilizável, potencialmente, ajudar tantas pessoas como melhorar a base de 100 artigos. Nós acompanhamos as mudanças que precisam ser concluídas em this dashboard. Isto é ordenado pela classificação do artigo de modo que você possa facilmente compreender o que deve ser trabalhado em primeiro lugar.

Exceptions:
Natuaralmente que a popularidade não é a única prioridade. Estas exceções também devem ser levadas em consideração.

  • Quebrando questões - Ocasionalmente, novas questões são relatadas em nosso fórum de suporte, que são melhores tratadas por atualizar um artigo da base de conhecimento. Por exemplo, um problema que afeta as pessoas que usam o Flash (99% dos usuários Firefox), por esse motivo, seria mais importante esta atualização do que uma pequena alteração a um recurso existente em uma nova versão do Firefox.
  • Anticipated demand - Ocasionalmente, iremos atualizar um artigo na expectativa de um novo recurso ou alteração na característica. O artigo atual pode até não estar em uma classificação particularmente elevada, mas estamos razoavelmente seguros com base em nossa experiência e nos planos de marketing que estes artigos irão se tornar populares.
  • Documentacão móvel - Como esses produtos (Firefox para dispositivos móveis, Firefox OS) têm relativamente poucos usuários, seus artigos não podem "competir" com artigos de desktop do Firefox. Os artigos para estes produtos devem ser considerados no contexto como demanda relativa por documentação de recursos e problemas relacionados com o produto individual.
  • Linked articles - Estes artigos estão relacionados a partir de produtos internos ou na mozilla.org.

Localização:
A fim de minimizar o trabalho dos localizadores, o nosso objetivo é ter atualizações para os 20 melhores artigos concluídos, basicamente a cada seis semanas. Como isso funciona, é que as atualizações não essenciais (atualizações para novas funcionalidades, pequenas correções e melhorias) para estes artigos são feitos em Inglês, mas não marcados como concluídos de imediato para a localização. Quatro semanas antes de um lançamentode produto, vamos marcar as mudanças para os 20 melhores artigos concluídos para a localização. Iremos tentar manter estes artigos estáveis para as próximas seis semanas. As vezes, quebrando os problemas ou falhas podem nos forçar a alterar os artigos novamente. A cada seis semanas vamos criar uma lista de prioridades (example) como uma diretriz para os localizadores baseado em nossa experiência com o Inglês.

Onde é que vamos falar sobre os artigos?

Em geral, temos dois tipos de discursos sobre os artigos da base de conhecimento:

  • Artigos individuais - cada artigo tem seu próprio guia de discussão. Os usuários podem postar seus comentários e opiniões sobre os artigos por aqui, e podemos com isso discutir o que é necessário ser revisto, os méritos relativos as revisões e questões relacionadas com o artigo.
    New Article Discussion
  • A base de conhecimento por completo - discutimos idéias e questões com a estratégia global da base de conhecimento, políticas e software no Artigos Forum.

Como podemos manter os artigos atualizados com a versão mais recente dos protuso da Mozilla?

Existem quatro versões dos produtos da Mozilla (Firefox, Firefox OS para dispositivos móveis) a serem construídos de uma só vez. Nos referimos a estas versões como "trens." Cada trem se move de um canal (ou trilho para continuar a metáfora do trem) a cada seis semanas. Temos Nightly, Aurora, Beta e Canais de Lançamento. Durante seis semanas novos recursos e correções são adicionados a esses produtos, enquanto estão no canal Nightly. Em seguida, move-se para a versão do canal Aurora para testes. Após seis semanas estando em Aurora, move-se para o canal Beta. E finalmente, depois de seis semanas de testes em Beta, essa se torna a versão de lançamento do produto. A fim de acompanhar as mudanças nos produtos, nossa documentação escrita também segue um ciclo de seis semanas.

doc schedule

Doc Ciclo Semanas 1 - 4

  • Localizar Beta: Uma vez que os artigos tenham sido finalizados (no cliclo anterior), haverá quatro semanas para localizá-los antes do lançamento. Iremos assinalar as revisões assim que forem finalizadas de forma que sejam exibidas nos painéis de Localização.
    • Nota: Nas duas semanas anteriores a esta, também podemos fazer atualizações com base na experiência do último lançamento, que também será incluído neste lote de artigos para localizar.
  • Projeto Aurora: Teremos quatro semanas para elaborar novos artigos e atualizações de artigos existentes. Iremos seguir a página Release Tracking para identificar quais mudanças e adições terá documentação.
  • Trilha Nightly: Iremos seguir a página Release Tracking para identificar quais mudanças e adições necessitará documentação. O rastreamento de recursos do Firefox é um processo permanente que vai continuar através de sua fase Beta, mas após a mudança para o Aurora, as principais mudanças só devem possibilitar a remoção de uma característica.
  • Arquivo: Como nossos produtos, serviços e documentação estarão mudando à medida que novas versões são lançadas, usaremos esse tempo para avaliar se existem artigos que são:
    • Obsoletos porque nossos produtos e serviços mudaram
    • Obsoletos porque eles tem tão pouca visibilidade que não são motivo de preocupação para a grande maioria dos usuários.

Doc Ciclo Semanas 5 & 6

  • Atualização de Lançamento: As novas versões dos produtos da Mozilla deverão ser lançadas de tal modo, que se necessário, seremos capazes de retornar e fazer ajustes em nossa documentação com base nos retornos e experiências dos fóruns de suporte.
  • Finalizar Beta: Uma vez que o Aurora passe para o Beta, teremos duas semanas para finalizar esses artigos que foram elaborados. Durante esse tempo vamos:
    • Adicionar telas e vídeos capturados da tela, se necessário
    • Revisar e aprovar os artigos
    • Assinale a revisão final como Pronto para Localização
  • Começar a acompanhar o novo Nightly: Uma nova versão será agora no canal Nightly.

Como faço para acompanhar o que está acontecendo?

Melhorando artigos

Melhorar os artigos da Base de Conhecimento é provavelmente 90% do trabalho que fazemos. Com cerca de 200 artigos da Base de Conhecimento, há sempre alguma coisa que pode ser feito melhor. Aqui estão as três principais formas de melhorar um artigo:

  • Mantenha artigos atualizados – grandes atualizações sempre trazem novas funcionalidades para os produtos e serviços da Mozilla, e muda a forma como os recursos existentes funcionam. É sempre melhor quando nossas instruções realmente correspondem à forma como as coisas funcionam no produto.
  • Prova de leitura – Alguns de vocês têm poderes especiais para detectar os erros que a verificação ortográfica deixou passar (quantos você já reparou neste artigo até agora?). Precisamos da sua ajuda.
  • Produzir artigos mais fáceis de entender
    • Encontre a melhor maneira de explicar algo que seja bastante complexo ou não muito evidente.
    • Adicionar captura de tela para ajudar as pessoas a entender o que no mundo o artigo está se referindo. A maioria das pessoas provavelmente não sabem a diferença entre o bar local, pesquisa de bar ou qualquer outro bar, a menos que tenha um happy hour.
    • Adicionar vídeos capturados da tela. Esta é a próxima melhor coisa para efetivamente pegar o mouse da mão de alguém e fazer por eles.

Qual é o processo para editar um artigo?

No mínimo, tudo o que você precisa fazer é clicar em Edit Article, fazer algumas alterações e enviá-las para a revisão. Todo o processo se parece com isso:

  1. Vá para o Need Changes section of the Contributor Dashboard
  2. A partir de comentários que relatam o que necessita ser feito, escolha um artigo. Expandir Editing Tools e dê uma olhada nas argumentações a fim de dispor de informações pertinentes a este artigo.
  3. Editar o artigo. Veja Como escrever artigos, para a base de conhecimento para dicas de estilo.
    • Use o botão Preview Content para verificar as suas alterações.
  4. Clique no botão Submit for Review para salvar as alterações. Sua edição será relacionada no Unreviewed Changes section of the Contributor Dashboard.

Se estiver demorando muito para obter uma revisão você pode executar o comando ping michaelverdi no #sumo IRC channel ou via email.

Se o revisor não aprovar o artigo, ele irá postar as razões e comentários no tópico da página de Discussão do artigo. As vezes, os revisores também irão criar uma nova revisão baseado nas suas alteções e poderá adicionar ou alterar algumas coisas.

Você (ou outro colaborador) pode criar outra revisão e fazer mais mudanças. Geralmente, leva algumas rodadas para acertar as coisas.

Criando um novo artigo

Se você acha que há algum artigo que necessitamos adicionar a Base de Conhecimento, aqui está como fazê-lo.

Certifique-se de procurar na Base de Conhecimento para ver se já existe algum artigo para o tópioco que você deseja documentar
  1. Criar um novo artigo e preencha o formulário usando a fonte do outro artigo como um guia.
  2. Elaborar o conteúdo do artigo.
  3. Verifique o seu trabalho utilizando o botão Preview Content.
  4. Clique no botão Submit for Review e informe a razão para a elaboração do artigo no comentário.
    • Fazendo isso, o artigo é recebido pelo Painel da Base de Conhecimento para que as pessoas saibam que está sendo aguardado para edição ou revisão.
    • O artigo não será publicado até que seja analisado e aprovado.

Estilo

Pretendemos que o Ajuda Mozilla seja utilizável por todos os usuários. Isto significa que estamos escrevendo para um universo indefinido, ao invés de um público que seja bastante familiarizado com as técnicas e terminologias de informática.

  • A pessoa para quem você está escrevendo não sabe como alterar as preferências ou adicionar um botão na barra de ferramentas, se não houver as instruções passo-a-passo.
  • Assuma que as pessoas não alteraram nenhum produto padrão ou configurações do sistema operacional.
  • Estilo de escrita de conversação – Adote um estilo informal e ativo, semelhante à maneira como você falaria com alguém, se estivesse pessoalmente.
  • Imagens e vídeos – Utilizando imagens e vídeos para explicar as coisas em conjunto com o texto não só é uma das melhores formas que temos para ajudar as pessoas, como também uma maneira fácil de incluir vários estilos de aprendizagem e repetição.

Para saber mais, consulte Como escrever artigos, para a base de conhecimento.

Remarcação

Nosso wiki utiliza a sintaxe MediaWiki, paralelo com algumas ações especiais para os botões de estilo, chaves, menus, etc. Veja o Tabela de marcação para a lista de exemplos.

{for}

Como usar {for} contém instruções e exemplos para demonstrar e ocultar as instruções para diferentes versões do Firefox e sistemas operacionais.

Modelos

Temos uma lista de templates que utilizamos em artigos de modo que a mesma parte da instrução não tenha que ser re-escrita, localizada e mantida em sincronia em vários artigos. Como usar Templates explica como eles funcionam.

Imagens & Vídeos Tutoriais

Devemos nos certificar de que os artigos são escritos para trabalhar sem imagens e vídeos. Entretanto ambas as imagens e vídeos são importantes e melhoram significativamente a utilidade de um artigo, mas não podem ser obrigatórios. Localizadores devem se sentir a vontade para usá-los ou excluí-los como bem entenderem.

Prioridade Desktop

  1. Windows - com cerca de 90% de nossos usuários no Windows, nem é necessário raciocinar muito pra entender que isso facilita muito. Por enquanto deveríamos capturar as imagens de telas do Windows 7. Quando adicionamos support for Windows XP, iremos também adicionar imagens específicas que sejam compatíveis.
  2. Mac - a versão atual é 10.8 (Mountain Lion).
  3. Linux - usar o Ubuntu para capturar as imagens de telas.

Dispositivo Móvel

  1. Android - 4.0 Ice Cream Sandwich.

Adicionando e removendo artigos

Propondo novos artigos

Nossa base de conhecimento é o que faz toda a nossa escala de esforço e apoio para servir centenas de milhões de usuários do Firefox. A coisa mais eficiente que podemos fazer é responder as perguntas que as pessoas fazem sobre os produtos e serviços da Mozilla em forma de artigo. Mas os artigos não vêm sem um custo. Cada artigo tem que ser escrito, localizado e mantido. Com muitos recursos e questões já documentados, muitas vezes uma melhor utilização do nosso tempo coletivo é melhorar os artigos já existentes. Antes que você saia correndo como um louco para criar novos artigos, vamos verificar algumas ações que você deve considerar em primeiro lugar:

Será que realmente necessitamos deste artigo?
Estas são as principais razões pelas quais nós adicionamos um novo artigo à Base de Conhecimento, entretanto muitas vezes, faz mais sentido atualizar ou adicionar um texto a um artigo já existente.

  • Novos recursos - voltada para recursos de usuário, que são plausíveis de gerar grande interesse e questões por parte dos usuários. Este pode ser um aspecto inerente da característica, em consequência da comercialização e vínculo do produto ou uma combinação dos dois.
  • Novas questões - Questões que têm grande número de tópicos recentes e votos no fórum de suporte.
  • Alto impacto - Critica, questões sensíveis ao tempo que precisam de documentação temporária (por exemplo Pogo.com and other Java pages don't work)

Arquivamento de artigos

Vamos arquivar periodicamente os artigos da base de conhecimento, para manter nosso foco nos ítens mais relevantes para os usuários. Como lançamos os produtos da Mozilla a cada seis semanas, as questões e ítens que os usuários necessitam de documentação deverão ser atualizados num ritmo muito mais rápido. Haverá uma série de artigos (como Como eu utilizo os Favoritos? ou Como definir a página inicial) que vão ficar circulando por um bom tempo, mas haverão outros artigos que se tornam obsoletos ou que não sejam tão interessantes para os usuários. O ideal é termos cerca de 200 artigos. Isso nos permitirá documentar em detalhes suficientes, sendo uma quantidade suficiente para manter e localizar.

Como funciona:
Contribuintes com privilégios de revisor podem marcar um artigo como obsoleto, editando a seção de descrição de um artigo. Isto irá remover o artigo de todos os painéis de controle (incluindo os painéis de localização) e da pesquisa normal. Você ainda pode ver o artigo utilizando a pesquisa avançada, e claro, os links para o artigo seriam preservados. Porém, haverá um banner no topo do artigo, deixando claro que este não é mais mantido e pode estar desatualizado.

Arquivar um artigo não é uma via de mão única. Uma vez que um artigo tenha sido arquivado, vamos monitorar as estatísticas para termos certeza de que o artigo não tenha sido popular. Caso tenhamos cometido um engano, retornar é tão fácil como clicar em uma caixa de seleção para obter o artigo novamente para os painéis.

Fatores a serem considerados antes de arquivar um artigo:

  • Poucas visualizações - Generalmente, os artigos com menos de 1500 visitas por mês, aproximadamente.
  • Poucos relatos recentes - Questões que tem relativamente poucos tópicos recentes e votos no fórum de suporte.
  • Baixo impacto - A remoção do artigo não é suscetível de causar ou exacerbar um problema sério.
  • Alterações de produtos e serviços - Circunstâncias em que uma questão foi resolvida ou uma mudança no comportamento fez algo se tornar obsoleto.

Diretrizes na revisão de artigo

Minha nossa! Já há muito tempo este era pra ser um artigo separado Guia para revisão de artigos.

Este artigo foi útil? Por favor, aguarde...

Colaboradores que ajudaram a escrever este artigo: ouesten, JeffGuimaraes. Você também pode ajudar - descubra como.