En esta página, se incluyen los detalles de un proyecto de redacción técnica aceptado para la Google Season of Docs.
Resumen del proyecto
- Organización de código abierto:
- Qubes OS
- Redactor técnico:
- luzeal
- Nombre del proyecto:
- Onboard with QubesOS ! Let's write an open and easy-to-use guide
- Duración del proyecto:
- Duración estándar (3 meses)
Descripción del proyecto
Onboard with QubesOS !
Me gustaría crear una guía abierta y materiales relacionados para los usuarios de QubesOS que lo usan por primera vez. El objetivo sería presentar QubesOS a los usuarios no especializados y mantener la guía lo más concisa y comprensible posible, usando analogías, ilustraciones y diagramas. Para que sea concisa, se usarán vínculos a recursos confiables, incluidos, en primer lugar, los que se encuentran en el sitio web de QubesOS. Todo se lanzará con una licencia abierta.
Por independiente, me refiero a un contenido que podría existir independientemente del sitio web, por ejemplo, como un manual. No equivale a la versión sin conexión de la guía. Lo ideal sería crear otra canalización para publicar el contenido como una guía, junto con el sitio web.
Por abierto, me refiero a una guía que se lanzará con una licencia abierta.
Cómo se podría hacer
Define el público objetivo
Hasta hoy, tengo la impresión de que la categoría de usuarios a la que se dirige QubesOS no está bien definida. ¿Cómo puede ayudar QubesOS a periodistas, abogados, analistas de seguridad, desarrolladores de software, etcétera? Sería esclarecedor describir situaciones en las que QubeOS puede resultar útil.
Establece las expectativas adecuadas
También sería importante advertir a los usuarios que usan QubesOS por primera vez que este requiere un nivel adecuado de conocimientos de TI. Hay un precio que pagar para usar QubesOS, en términos de usabilidad, en especial si QubesOS es tu sistema informático principal. Del mismo modo, hay cosas que QubeOS no hará bien (por diseño), como la aceleración 3D en máquinas virtuales. Es importante dejarlo claro desde el principio, no para disuadir a las personas de usarlo, sino para establecer expectativas para los usuarios potenciales.
Qué es QubesOS y qué no es
Aunque QubesOS es un tipo especial de sistema operativo (una distribución de Xen), sería interesante compararlo con otros sistemas operativos en función de sus funcionalidades o la falta de ellas (por ejemplo, Windows usa cada vez más la virtualización y el aislamiento como mecanismos de seguridad). Se podría usar un diagrama o una tabla simple.
Las especificaciones de la guía se definirán con la comunidad.
¿Cuál es la información mínima que debe contener la guía? ¿Cuánto se puede simplificar la instalación sin sacrificar la seguridad? ¿Dónde debería estar el umbral? ¿Existe una configuración de QubesOS mínima, viable y segura? Si no es así, se podría definir y establecer como objetivo de la guía.
Licencia
Elige una licencia. La respetada wiki de Archlinux usa la licencia de documentación libre de GNU 1.3 o versiones posteriores. ¿Esta licencia sería adecuada?
Otros esfuerzos
Haz que la documentación del sitio web sea más atractiva visualmente
Las notas se pueden destacar con colores rojo o amarillo para que sean más fáciles de notar. Por ejemplo, se podrían usar cuadros de color, como los que se encuentran en la wiki de archlinux. https://wiki.archlinux.org/index.php/Linux_Containers.
Se podrían usar citas en bloque.
Vincular contenido
Actualmente, hay mucho contenido para el sitio web de documentación, pero las partes individuales a menudo no están vinculadas a otros temas relevantes. Los artículos se pueden vincular entre sí para mejorar la visibilidad.