Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la temporada de Documentos de Google.
Resumen del proyecto
- Organización de código abierto:
- SO Qubes
- Escritor técnico:
- c1e0
- Nombre del proyecto:
- Consolida las guías de solución de problemas
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
RESUMEN
Una guía de solución de problemas está diseñada para ayudar a los usuarios finales a resolver cualquier problema que encuentren cuando usen un producto o servicio. Una buena guía de solución de problemas es importante porque ayuda a los usuarios cuando surgen problemas. Evita que los usuarios abandonen un producto cuando se encuentren con un problema. Qubes tiene miles de usuarios diarios en todo el mundo, muchos de los cuales se enfrentarán a un problema en algún momento y se beneficiarán de una guía de solución de problemas.
ESTADO ACTUAL DE LA GUÍA DE SOLUCIÓN DE PROBLEMAS
En este momento, las guías de solución de problemas de QubesOS están dispersas en muchas páginas y, a veces, están incompletas, lo que lleva a publicar la misma instrucción una y otra vez para ayudar a los usuarios a diagnosticar problemas. Las guías disponibles no tienen un diseño de acción de síntomas, lo que hace que sea difícil para el usuario hacer coincidir un problema con su solución. Además, hay algunos problemas que se mencionaron repetidamente en las redes sociales (Reddit), en la página de problemas de GitHub de Qubes y en el foro de #qubes-users, pero que no se documentaron en la guía de solución de problemas actual.
¿POR QUÉ MI PROPUESTA DE SOLUCIÓN DE PROBLEMAS GUÍA UNA MEJORA SOBRE LA ACTUAL?
La guía de solución de problemas que propongo estará completa y estructurada para garantizar precisión y facilidad de navegación. La guía mostrará instrucciones concisas que explican cómo resolver un problema de manera paso a paso. Tendrá un diseño de acción de síntomas, en el que se planteará un problema, seguido de una solución recomendada para resolverlo. La resolución de problemas se optimizará para motores de búsqueda y se redactará para tener en cuenta qué problemas buscan los usuarios en las redes sociales y los motores de búsqueda. Todas estas medidas permitirán que los usuarios encuentren la guía oficial de solución de problemas a través de los motores de búsqueda y que encuentren rápida y fácilmente la solución a sus problemas.
ESTRUCTURA DE LA GUÍA DE SOLUCIÓN DE PROBLEMAS PROPUESTAS Y EL PLAZO
Creé una estructura propuesta para la guía de solución de problemas de Qubes OS, que puedes encontrar aquí: https://docs.google.com/document/d/187NlnEvctYVVUnRuGtwY2PkYBVxBSSPfpSwZEaczqL8/edit?usp=sharing. El diseño incluye un plazo estimado durante el cual se escribirá cada sección de solución de problemas. Este diseño se implementará después de los comentarios del mentor. La estructura y el plazo se pueden modificar en función de los comentarios de los mentores.
OBJETIVOS DEL PROYECTO
- Reestructura la guía de solución de problemas para tener un diseño de acción de los síntomas más integral y consolidado.
- Reescribir los problemas existentes para tener instrucciones paso a paso fáciles de seguir.
- Agrega capturas de pantalla cuando sea necesario
- Instalar y probar Qubes por mi cuenta, y registrar los problemas que se detecten Tengo tres computadoras: una Lenovo Thinkpad, Dell Latitude y una Acer Aspire. Probaré Qubes en cada una de estas computadoras para registrar los errores y validar los problemas.
- Quita cualquier información obsoleta de la guía existente.
- Asegúrate de que los problemas de problemas sean precisos. Por el momento, las guías de solución de problemas existentes tienen el mensaje de error "Esta es documentación no oficial de terceros. El proyecto de SO de Qubes no puede garantizar la exactitud de esta página. Ten cuidado"". Esta advertencia se descartará después de que se verifiquen que las instrucciones para la solución de problemas sean precisas. Para garantizar su precisión, puedo probar personalmente la solución de problemas en mis PC (si es posible) o consultar en línea si algún usuario validó la solución.
- Migra los problemas de solución de problemas externos (del foro y GitHub) a la página web oficial de solución de problemas.
- Investiga y descubre más problemas que enfrentan los usuarios de Reddit (r/QubesOS), Stack Exchange, el grupo de Google #qubes-users y problemas de GitHub. También usaré herramientas de investigación de palabras clave, como Keywordtool.io y UberSuggest.com, para descubrir qué preguntas se buscan con frecuencia en motores de búsqueda como Google.
- Agrega una sección para obtener ayuda en caso de que la guía de solución de problemas no resuelva el problema de los usuarios. Puedes ver un ejemplo en la página de solución de problemas de Fedora: https://docs.fedoraproject.org/en-US/fedora/rawhide/install-guide/install/Troubleshooting/#sect-troubleshooting-getting-help.
¿POR QUÉ ESTE PROYECTO?
Me apasiona la tecnología, en particular la seguridad cibernética y la privacidad. Creo que la escritura es una de mis fortalezas. Me interesa en particular el SO Qubes porque se superpone con dos intereses principales: la seguridad y la privacidad. Soy un usuario ávido de otros productos centrados en la seguridad y la privacidad, como DuckDuckGo y Tor. Recién descubrí Qubes OS y me encanta hasta ahora.
POR QUÉ CREO QUE SOY LA PERSONA ADECUADA PARA ESTE PROYECTO
- Me apasionan la seguridad y la privacidad, y la redacción de documentación útil o de calidad.
- Debido a que tuve problemas durante la instalación y el uso de Qubes OS, podré representar mejor estos problemas en las instrucciones de solución de problemas.
- En el último mes, estudié los aspectos técnicos del sistema operativo Qubes. También estudié la documentación de Qubes OS ampliamente. Para hacerte una idea del proceso de edición de documentación, creé una solicitud de extracción (https://github.com/QubesOS/qubes-doc/pull/1005/files).
- Recientemente, completé una pasantía en el proyecto Tor. Mis funciones fueron las de asistencia técnica y redacción. Mientras trabajaba en el departamento de ayuda, recibí cientos de preguntas de usuarios que tenían problemas al instalar o utilizar el navegador Tor. Al ayudar a estos usuarios a solucionar sus problemas, aprendí a escribir instrucciones concisas y comprensibles para la solución de problemas
- Mientras trabajaba en el proyecto Tor, también escribí documentación técnica con Markdown. Usé Git, GitHub y GitLab para controlar las versiones.