En esta página, se incluyen 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:
- Qubes OS
- Redactor 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
ABSTRACT
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 encuentran un problema. Qubes tiene miles de usuarios diarios en todo el mundo, muchos de los cuales tendrán 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 cuando se ayuda a los usuarios a diagnosticar problemas. Las guías disponibles no tienen un diseño de síntomas y acciones, lo que dificulta que un usuario relacione un problema con su solución. Además, hay algunos problemas que se mencionaron varias veces en las redes sociales (Reddit), en la página de problemas de Qubes en GitHub y en el foro #qubes-users, pero no se documentaron en la guía de solución de problemas actual.
¿POR QUÉ MI GUÍA DE SOLUCIÓN DE PROBLEMAS PROPUESTA ES UNA MEJORA CON RESPECTO A LA ACTUAL?
La guía de solución de problemas que propongo estará completa y estructurada para garantizar la precisión y la navegación sencilla. En la guía, se mostrarán instrucciones concisas que explican cómo resolver un problema de forma paso a paso. Tendrá un diseño de síntomas y acciones, en el que se indicará un problema, seguido de una solución recomendada para resolverlo. Las soluciones de problemas se optimizarán para los motores de búsqueda y se redactarán de manera tal que se tengan en cuenta los problemas que los usuarios buscan en las redes sociales y los motores de búsqueda. Todo esto se hará para garantizar que los usuarios puedan encontrar la guía oficial de solución de problemas a través de los motores de búsqueda y encontrar la solución a sus problemas de forma rápida y sencilla.
ESTRUCTURA DE LA GUÍA DE SOLUCIÓN DE PROBLEMAS PROPUESTA Y PLAZO
Creé una estructura propuesta para la guía de solución de problemas de Qubes OS, que se encuentra aquí: https://docs.google.com/document/d/187NlnEvctYVVUnRuGtwY2PkYBVxBSSPfpSwZEaczqL8/edit?usp=sharing. El diseño se acompaña de un período 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 pueden modificarse en función de los comentarios del mentor.
OBJETIVOS DEL PROYECTO
- Reestructura la guía de solución de problemas para tener un diseño de síntomas y acciones más comprensible y consolidado.
- Vuelve a escribir las soluciones de problemas existentes para que tengan instrucciones paso a paso fáciles de seguir.
- Agrega capturas de pantalla cuando sea necesario.
- Instalar y probar Qubes por mi cuenta, y registrar cualquier problema que encuentre Tengo tres computadoras: una Lenovo Thinkpad, una Dell Latitude y una Acer Aspire. Probaré Qubes en cada una de estas computadoras, registraré los errores y validaré cualquier solución de problemas.
- Quita la información obsoleta de la guía existente.
- Asegúrate de que los pasos de solución de problemas sean precisos. A partir de ahora, las guías de solución de problemas existentes tienen el mensaje de error ""Esta es una documentación no oficial de terceros. El proyecto Qubes OS no puede garantizar la exactitud de esta página. Ten cuidado"". Esta advertencia se descartará después de que se verifique que las instrucciones de solución de problemas son precisas. Su precisión se garantizará ya sea probando personalmente los problemas de solución en mis PC (si es posible) o consultando en línea si algún usuario ha validado la solución.
- Migra los problemas externos (del foro y GitHub) a la página web oficial de solución de problemas.
- Investiga y encuentra más problemas que enfrentan los usuarios de Reddit (r/QubesOS), Stack Exchange, el Grupo de Google de #qubes-users y 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 “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 especial la seguridad cibernética y la privacidad. Creo que la escritura es una de mis fortalezas. Me interesa especialmente el SO de Qubes porque se cruza con dos de mis principales intereses: la seguridad y la privacidad. Soy un usuario ávido de otros productos enfocados en la seguridad y la privacidad, como DuckDuckGo y Tor. Hace poco descubrí Qubes OS y me encanta.
POR QUÉ CREO QUE SOY LA PERSONA ADECUADA PARA ESTE PROYECTO
- Me apasiona la seguridad, la privacidad y escribir documentación útil y de calidad.
- Como tuve problemas para instalar y usar Qubes OS, podré representarlos mejor en las instrucciones para solucionar problemas.
- Durante el último mes, estudié los aspectos técnicos del sistema operativo Qubes. También estudié mucho la documentación de Qubes OS. Para tener 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 eran de asistencia técnica y redacción. Mientras trabajaba en el servicio de asistencia, recibí cientos de preguntas de usuarios que tenían problemas para instalar o usar el navegador Tor. A través de la ayuda a estos usuarios para solucionar sus problemas, aprendí a escribir instrucciones de solución de problemas concisas y comprensibles.
- Mientras trabajaba en el proyecto Tor, también escribí documentación técnica con Markdown. Usé Git, GitHub y GitLab para el control de versiones.