Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la GDOC Season of Docs.
Resumen del proyecto
- Organización de código abierto:
- Qubes OS
- Redactor técnico:
- enamorado
- Nombre del proyecto:
- Integración con QubesOS Escribamos una guía abierta y fácil de usar
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Integra QubesOS
Me gustaría crear una guía abierta y materiales relacionados para los usuarios de QubesOS por primera vez. El objetivo sería presentar QubesOS a los profanos y mantener la guía lo más concisa y comprensible posible, con analogías, ilustraciones y diagramas. Para que sea conciso, 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á bajo una licencia abierta.
Cuando digo independiente, me refiero a un contenido que podría existir independientemente del sitio web, por ejemplo, como un manual. No es equivalente a la versión sin conexión de la guía. Idealmente, se creará otra canalización para publicar el contenido como guía junto con el sitio web.
Cuando hablamos de "abierto", nos referimos a una guía que se lanzará con una licencia abierta.
Cómo se podría hacer
Define el público objetivo
A partir de hoy, tengo la impresión de que la categoría de usuarios a la que se orienta QubesOS no está bien definida. ¿Cómo puede QubesOS ayudar a periodistas, abogados, analistas de seguridad, desarrolladores de software, etcétera? Sería útil describir situaciones en las que QubeOS puede resultar útil.
Establece las expectativas correctas
También sería importante advertir a los usuarios que usan QubesOS por primera vez que este sistema requiere un nivel considerable de conocimiento de TI. El uso de QubesOS tiene un precio muy alto en términos de usabilidad, especialmente si QubesOS es tu sistema de procesamiento principal. Del mismo modo, hay aspectos que QubeOS no realizará bien (por diseño), como la aceleración en 3D en máquinas virtuales. Es importante dejar claro desde el principio, no disuadir a las personas de usarlo, sino establecer excepciones para los usuarios potenciales.
Qué es QubesOS y qué no
Aunque QubesOS es una variedad especial de sistema operativo (una distribución de Xen), sería interesante compararlo con otros sistemas operativos en función de sus funciones o la falta de ellas (por ejemplo, Windows usa cada vez más la virtualización y el entorno de pruebas como mecanismos de seguridad). Se puede usar un diagrama o una tabla simples.
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? ¿En qué medida se puede simplificar la instalación sin sacrificar la seguridad? ¿Dónde debería estar el umbral? ¿Existe una configuración de QubesOS mínimamente viable y segura? De lo contrario, 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 una posterior. ¿Esta licencia sería una buena opción?
Otros esfuerzos
Haz que la documentación del sitio web sea más atractiva a la vista
Las notas se pueden destacar con colores rojo o amarillo para que sean más fáciles de ver. Por ejemplo, se podrían usar cuadros de colores, como los que se encuentran en la wiki de Arch Linux. https://wiki.archlinux.org/index.php/Linux_Containers.
Se podrían usar citas.
Vincula el contenido
Actualmente hay mucho contenido para el sitio web de documentación, pero las piezas individuales a menudo no están vinculadas a otros temas relevantes. Los artículos se pueden vincular entre sí para mejorar la visibilidad.