Esta página contém os detalhes de um projeto de redação técnica aceito para a Google Season of Docs.
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 consolidados
- Duração do projeto:
- Duração padrão (três meses)
Project description
ABSTRATA
Um guia de solução de problemas foi criado para ajudar os usuários finais a resolver qualquer problema encontrado ao usar um produto ou serviço. Um bom guia de solução de problemas é importante porque ajuda os usuários quando surgem problemas. Isso 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, e muitos deles vão enfrentar problemas em algum momento e se beneficiar 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 espalhados por muitas páginas e às vezes incompletos, o que leva a postar repetidamente a mesma instrução para ajudar os usuários a diagnosticar problemas. Os guias disponíveis não têm um layout de ação de sintoma, o que dificulta a correspondência de um problema com a solução. Além disso, há alguns problemas que foram mencionados repetidamente nas mídias sociais (Reddit), na página de problemas do Qubes no GitHub e no fórum #qubes-users, mas não foram documentados no guia de solução de problemas atual.
POR QUE MEU GUIA DE SOLUÇÃO DE PROBLEMAS PROPOSTO É MELHOR DO QUE O ATUAL?
O guia de solução de problemas que propus será completo e estruturado para garantir a precisão e a navegação fácil. O guia vai mostrar instruções concisas que explicam como resolver um problema passo a passo. Ele terá um layout de sintoma-ação, em que um problema será declarado, seguido por uma solução recomendada para resolvê-lo. As soluções de problemas serão otimizadas para mecanismos de pesquisa e formuladas para considerar quais problemas os usuários estão pesquisando nas mídias sociais e nos mecanismos de pesquisa. Tudo isso ajudará os usuários a encontrar o guia oficial de solução de problemas nos mecanismos de pesquisa e a encontrar a solução para seus problemas de maneira rápida e fácil.
ESTRUTURA DO GUIA DE SOLUÇÃO DE PROBLEMAS PROPOSTO e PRAZO
Criei uma estrutura proposta para o guia de solução de problemas do Qubes OS, 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 prazo podem ser modificados com base no feedback do mentor.
METAS DO PROJETO
- Reestruturar o guia de solução de problemas para ter um layout de ação-sintoma mais compreensível e consolidado.
- Reescreva as soluções de problemas atuais para ter instruções detalhadas fáceis de seguir.
- Adicione capturas de tela quando necessário
- Instalar e testar o Qubes e registrar todos os problemas encontrados. Tenho três computadores: um Lenovo Thinkpad, um Dell Latitude e um Acer Aspire. Vou tentar o Qubes em cada um desses computadores, registrando os erros e validando as soluções.
- Remova todas as informações obsoletas do guia atual.
- Confira se as soluções de problemas estão corretas. No momento, os guias de solução de problemas atuais têm a mensagem de erro "Esta é uma documentação não oficial de terceiros. O Projeto Qubes OS não pode garantir a precisão desta página. Tome cuidado"". Esse aviso será descartado depois que as instruções de solução de problemas forem verificadas como precisas. A precisão será garantida testando pessoalmente as soluções de problemas nos meus PCs (se possível) ou verificando on-line se algum usuário validou a solução.
- Migramos todas as soluções de problemas externas (do fórum e do GitHub) para a página da Web oficial de solução de problemas.
- Pesquise e encontre mais problemas enfrentados pelos usuários do Reddit (r/QubesOS), do Stack Exchange, do grupo #qubes-users do Google e dos problemas do 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.
- Adicione uma seção "Ajuda", caso o guia de solução de problemas não resolva o problema dos usuários. Confira um exemplo na página de solução de problemas do Fedora: https://docs.fedoraproject.org/en-US/fedora/rawhide/install-guide/install/Troubleshooting/#sect-troubleshooting-getting-help.
POR QUE ESSE PROJETO?
Sou apaixonada por tecnologia, principalmente segurança cibernética e privacidade. Acredito que a escrita é um dos meus pontos fortes. Estou particularmente interessado no Qubes OS porque ele atende a dois interesses importantes: segurança e privacidade. Sou um 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 SER A PESSOA CERTA PARA ESTE PROJETO
- Sou apaixonada por segurança, privacidade e escrita de documentação útil.
- Como tive problemas ao instalar e usar o Qubes OS, posso representar melhor esses problemas 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 extensivamente. Para ter uma ideia do 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 redação. Enquanto trabalhava no help desk, recebi centenas de perguntas de usuários que enfrentaram problemas ao instalar ou usar o Tor Browser. Ao ajudar esses usuários a resolver problemas, aprendi a escrever instruções concisas e compreensíveis.
- Enquanto trabalhava no Projeto Tor, também escrevi documentação técnica usando Markdown. Usei o Git, o GitHub e o GitLab para controle de versão.