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:
- Qubes OS
- Redator técnico:
- luzeal
- Nome do projeto:
- Integração com o QubesOS. Vamos escrever um guia aberto e fácil de usar
- Duração do projeto:
- Duração padrão (três meses)
Project description
Integração com o QubesOS!
Gostaria de criar um guia aberto e materiais relacionados para usuários iniciantes do QubesOS. O objetivo seria apresentar o QubesOS a pessoas leigas e manter o guia o mais conciso e compreensível possível, usando analogias, ilustrações e diagramas. Para manter a concisão, serão usados links para recursos confiáveis, incluindo, principalmente, aqueles presentes no site do QubesOS. Tudo será lançado sob uma licença aberta.
Por "independente", quero dizer um conteúdo que pode existir independentemente do site, por exemplo, como um manual. Isso não se compara à versão off-line do guia. O ideal é criar outro pipeline para publicar o conteúdo como um guia, junto com o site.
Por "aberto", quero dizer um guia que será lançado sob uma licença aberta.
Como isso pode ser feito
Definir o público-alvo
A partir de hoje, tenho a impressão de que a categoria de usuários que o QubesOS segmenta não está bem definida. Como o QubesOS pode ajudar jornalistas, advogados, analistas de segurança, desenvolvedores de software e assim por diante? Seria esclarecedor descrever os cenários em que o QubeOS pode ser útil.
Defina as expectativas da forma correta
Também é importante avisar aos usuários iniciantes que o QubesOS exige um bom nível de conhecimento de TI. Há um preço a pagar para usar o QubesOS, em termos de usabilidade, especialmente se ele for seu sistema de computação principal. No mesmo sentido, há coisas que o QubeOS não vai fazer bem (por design), como a aceleração 3D em máquinas virtuais. É importante deixar isso claro desde o início, não para impedir que as pessoas usem o app, mas para definir exceções para usuários em potencial.
O que é e o que não é o QubesOS
Embora o QubesOS seja uma espécie especial de sistema operacional (uma distribuição Xen), seria interessante compará-lo a outros sistemas operacionais com base nas funcionalidades ou na falta delas. Por exemplo, o Windows está usando cada vez mais a virtualização e o sandbox como mecanismos de segurança. É possível usar um diagrama/tabela simples.
As especificações do guia serão definidas com a comunidade.
Quais são as informações mínimas que o guia deve conter? Até que ponto a instalação pode ser simplificada sem sacrificar a segurança? Onde o limite precisa estar? Existe uma configuração mínima viável e segura do QubesOS? Se não, ele pode ser definido e definido como o destino do guia.
Licença
Escolha uma licença. O wiki do Archlinux, muito respeitado, usa a Licença de Documentação Livre GNU 1.3 ou mais recente. Essa licença seria adequada?
Outros endevoars
Deixar a documentação do site mais atraente
As notas podem ser destacadas usando cores vermelha ou amarela para facilitar a identificação. Por exemplo, caixas coloridas podem ser usadas, como as encontradas na wiki do archlinux. https://wiki.archlinux.org/index.php/Linux_Containers.
Podem ser usados blocos de citações.
Conteúdo do link
No momento, há muito conteúdo no site de documentação, mas as partes individuais geralmente não estão vinculadas a outros tópicos relevantes. Os artigos podem ser vinculados entre si para melhorar a capacidade de descoberta.