Projeto do Qubes OS

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:
SO do Qubes
Redator técnico:
c1e0
Nome do projeto:
Guias de solução de problemas de consolidação
Duração do projeto:
Duração padrão (3 meses)

Project description

ABSTRATA

Um guia de solução de problemas foi criado para ajudar os usuários finais a resolver problemas encontrados ao usar um produto ou serviço. Um bom guia de solução de problemas é importante porque ajuda os usuários quando surgem problemas. Evita que os usuários abandonem um produto quando encontram um problema. O Qubes tem milhares de usuários diários em todo o mundo, muitos dos quais enfrentarão um problema em algum momento e se beneficiarão de um guia de solução de problemas.

ESTADO ATUAL DO GUIA DE SOLUÇÃO DE PROBLEMAS

No momento, os guias de solução de problemas do QubesOS estão dispersos em muitas páginas e, às vezes, incompletos, levando à postagem repetida das mesmas instruções para ajudar os usuários a diagnosticar problemas. Os guias disponíveis não têm um layout de ação de sintomas, o que dificulta a correspondência de um problema com a solução. Além disso, alguns problemas foram mencionados repetidamente nas mídias sociais (Reddit), na página de problemas do GitHub do Qubes e no fórum #qubes-users, mas que não foram documentados no guia de solução de problemas atual.

POR QUE MEU GUIA DE SOLUÇÃO DE PROBLEMAS PROPOSTO É UMA AUMENTO EM RELAÇÃO AO ATUAL?

Meu guia de solução de problemas proposto será completo e estruturado para garantir precisão e navegação fácil. O guia vai apresentar instruções concisas que explicam como resolver um problema de forma passo a passo. Ele inclui um layout de ação de sintomas, em que um problema é declarado e uma solução recomendada. As soluções de problemas vão ser otimizadas para mecanismos de pesquisa e formuladas para levar em consideração quais problemas os usuários estão pesquisando nas mídias sociais e nos mecanismos de pesquisa. Tudo isso irá garantir que os usuários possam encontrar o guia oficial de solução de problemas em mecanismos de pesquisa e encontrar uma solução rápida/fácil para seus problemas

ESTRUTURA DO GUIA DE SOLUÇÃO DE PROBLEMAS E DO PERÍODO PROposto

Criei uma proposta de estrutura para o guia de solução de problemas do SO do Qubes, que pode ser encontrada aqui: https://docs.google.com/document/d/187NlnEvctYVVUnRuGtwY2PkYBVxBSSPfpSwZEaczqL8/edit?usp=sharing. O layout é acompanhado por um período estimado em que cada seção de solução de problemas será escrita. Esse layout será implementado após o feedback do mentor. A estrutura e o período podem ser modificados com base no feedback do mentor.

METAS DO PROJETO

  • Reestruture o guia de solução de problemas para ter um layout de ação de sintomas mais compreensível e consolidado.
  • Reescreva soluções de problemas atuais para ter instruções passo a passo fáceis de seguir.
  • Adicione capturas de tela quando necessário
  • Instalar e testar o Qubes por conta própria e registrar os problemas encontrados. Tenho três computadores: um Lenovo Thinkpad, Dell Latitude e um Acer Aspire. Tentarei usar o Qubes em cada um desses computadores, registrando os erros e validando as soluções de problemas.
  • Remova todas as informações obsoletas do guia existente.
  • Garanta que as soluções de problemas sejam precisas. No momento, os guias de solução de problemas atuais exibem a mensagem de erro "Esta documentação não é oficial de terceiros. O Qubes OS Project não pode garantir a precisão desta página. Tenha cuidado"". Este aviso será descartado depois que as instruções de solução de problemas forem verificadas. A precisão dos dados será assegurada pelo teste pessoal das soluções de problemas nos meus PCs (se possível) ou pela verificação on-line se algum usuário tiver validado a solução.
  • Migre as soluções de problemas externas (do fórum e do GitHub) para a página da Web oficial de soluções de problemas.
  • Pesquise e descubra mais problemas enfrentados pelos usuários no Reddit (r/QubesOS), Stack Exchange, #qubes-users Grupo do Google e GitHub. Também vou usar ferramentas de pesquisa de palavras-chave, como Keywordtool.io e UberSuggest.com, para descobrir quais perguntas são pesquisadas com frequência em mecanismos de pesquisa como o Google.
  • Inclua uma seção "Como receber ajuda" caso o guia de solução de problemas não resolva o problema do usuário. Veja um exemplo na página de solução de problemas do Fedora: https://docs.fedoraproject.org/pt-BR/fedora/rawhide/install-guide/install/Troubleshoot/#sect-troubleshooting-getting-help.

POR QUE ESTE PROJETO?

Adoro tecnologia, principalmente segurança cibernética e privacidade. Acredito que escrever é um dos meus pontos fortes. Estou particularmente interessado no SO do Qubes porque ele cruza dois dos meus interesses: segurança e privacidade. Sou usuário ávido de outros produtos com foco em segurança e privacidade, como DuckDuckGo e Tor. Descobri o Qubes OS recentemente e estou adorando.

POR QUE Acredito que SOU a PESSOA CERTA PARA ESTE PROJETO

  • Adoro segurança e privacidade e adoro escrever documentos úteis e de qualidade.
  • Como tive problemas ao instalar e usar o SO Qubes, vou poder representá-los melhor nas instruções de solução de problemas.
  • No mês passado, estudei os aspectos técnicos do sistema operacional Qubes. Também estudei a documentação do Qubes OS profundamente. Para entender o processo de edição da documentação, criei uma solicitação de envio (https://github.com/QubesOS/qubes-doc/pull/1005/files)
  • Recentemente, concluí um estágio no projeto Tor. Minhas funções eram suporte técnico e escrita. Enquanto trabalhava no helpdesk, recebi centenas de perguntas de usuários que tinham problemas ao instalar ou usar o navegador Tor. Ao ajudar esses usuários a resolver problemas, aprendi a escrever instruções de solução de problemas concisas e compreensíveis
  • Enquanto trabalhava no Tor Project, também escrevi documentação técnica usando Markdown. Usei o Git, o GitHub e o GitLab para o controle de versões.