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:
- Onboard com o QubesOS! Vamos escrever um guia aberto e fácil de usar
- Duração do projeto:
- Duração padrão (3 meses)
Descrição do projeto
Onboard com o QubesOS!
Gostaria de criar um guia aberto e materiais relacionados para usuários iniciantes do QubesOS. O objetivo é apresentar o QubesOS para leigos 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 possa existir de forma independente do site, por exemplo, como um manual. Isso não equivale à versão off-line do guia. O ideal é que outro pipeline seja criado 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
Atualmente, tenho a impressão de que a categoria de usuários que o QubesOS está segmentando 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 cenários em que o QubeOS pode ser útil.
Definir as expectativas certas
Também seria importante alertar os usuários iniciantes de 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 principal sistema de computação. Da mesma forma, há coisas que o QubeOS não fará bem (por design), como aceleração 3D em máquinas virtuais. É importante deixar isso claro desde o início, não para impedir que as pessoas o usem, mas para definir expectativas para usuários em potencial.
O que o QubesOS é e o que ele não é
Embora o QubesOS seja um tipo 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). Um diagrama/tabela simples pode ser usado.
As especificações do guia serão definidas com a comunidade.
Quais são as informações mínimas que o guia precisa conter? Quanto a instalação pode ser simplificada sem sacrificar a segurança? Onde o limite deve estar? Existe uma configuração mínima viável e segura do QubesOS? Se não, ela pode ser definida e definida como o destino do guia.
Licença
Retire uma licença. A wiki do Archlinux, muito respeitada, usa a GNU Free Documentation License 1.3 ou mais recente. Essa licença seria adequada?
Outros esforços
Deixar a documentação do site mais atraente visualmente
As notas podem ser destacadas usando cores vermelhas ou amarelas para facilitar a identificação. Por exemplo, caixas de cores podem ser usadas, como as encontradas na wiki do Archlinux. https://wiki.archlinux.org/index.php/Linux_Containers.
As citações em bloco podem ser usadas.
Conteúdo do link
Atualmente, há muito conteúdo para o site de documentação, mas as partes individuais geralmente não estão vinculadas a outros tópicos relevantes. Os artigos podem ser vinculados uns aos outros para melhorar a capacidade de descoberta.