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:
- Creative Commons
- Escritor técnico:
- JackieBinya
- Nombre del proyecto:
- Guía de uso del tema base de WordPress
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Durante la fase de postulación de escritor técnico de GSOD-2020, tuve varias interacciones con Hugo Solar, quien es el mentor del proyecto de documentación del tema base de WordPress de Creative Commons.
En mi contacto inicial con él, busqué ayuda para comprender los objetivos de crear la guía de uso del tema base de WordPress. Fue muy útil y me integró rápidamente al proyecto. Todas las interacciones consecutivas que tuvimos después se relacionaron con definir mejor los objetivos de la documentación del tema Base de WordPress de CC.
Cuando llegué a una etapa en la que sentí que entendía los requisitos y objetivos del proyecto, creé un borrador de propuesta para la Guía de uso del tema base de WordPress de CC.
La propuesta se creó utilizando la plantilla oficial de Creative Commons para las aplicaciones de pasantes. Proporciona información sobre la sinopsis del proyecto, la estructura propuesta y el diseño de la documentación del nuevo tema básico de WordPress, así como información sobre los cronogramas y las entregas para la fase de creación de documentos.
Luego, Hugo Solar revisó mi borrador de propuesta y me dio comentarios para hacer mejoras. Durante todo el proceso, siempre estuvo disponible para responder preguntas sobre el proyecto.
Implementé los comentarios recibidos y mi propuesta final para la documentación de la insignia de Building D&I está disponible en el siguiente vínculo como un Documento de Google.
https://docs.google.com/document/d/1XmIsMTLstbhRRSaNFP538YOXJiS0G5QrN6EzuqJfRy4/edit?usp=sharing
Como alternativa, puedes encontrar un breve resumen de mi propuesta a continuación:
Creative Commons - WordPress base theme usage guide A proposal prepared by Jacqueline Binya, 28 June 2020
Sinopsis del proyecto El objetivo final de este proyecto es crear documentación para la comunidad que sea atractiva, intuitiva, atractiva y bien presentada para el tema base de WordPress de Creative Commons.
Plan de proyecto El problema Actualmente, el tema Base de WordPress de Creative Commons no tiene documentación, lo que actúa como una barrera para el uso eficaz del tema dentro de la comunidad. Mi objetivo es crear una guía de uso completa para el tema y también implementar abstracciones en la base de código actual del tema WP Base para facilitar el uso del tema.
La solución Crea documentos futuristas con frameworks modernos como Gatsby. Gatsby tiene activadores que podemos usar para iniciar la nueva documentación del tema base de WordPress. Un ejemplo de activador es gatsby-gitbook-starter, que se incluye de forma predeterminada con compatibilidad con la optimización de motores de búsqueda (SEO), Markdown y Algolia ( una herramienta que se usa para integrar la búsqueda en sitios estáticos). Además, cualquier sitio generado por Gatsby se puede optimizar fácilmente para integrar la internacionalización y la accesibilidad. Cuando creo la documentación, mi intención es que sea lo más intuitiva posible de la siguiente manera: - Escribo los documentos de una manera fácil de entender y me cuido de evitar la ambigüedad y el uso de un lenguaje técnico demasiado complejo. - Incorporando ilustraciones gráficas y contenido multimedia en la documentación para usarlos como ayudas visuales para el aprendizaje. - Usar ejemplos que demuestren cómo ejecutar tareas comunes, p.ej., personalizaciones
Las abstracciones que espero implementar incluirán garantizar que la mayoría de las funciones principales del tema base de WP, como los hooks, por ejemplo, puedan aprovecharse por parte de los usuarios desde el panel de administración de WordPress. Además, me encantaría crear un tema secundario inicial para el tema base de WP en un repositorio independiente. Tener un tema secundario inicial proporcionaría una experiencia de integración más fluida y rápida para los usuarios nuevos. Una vez que se complete y apruebe la documentación, se publicará y alojará en línea.
La estructura propuesta de la Guía de uso del tema base de WordPress de CC: La documentación propuesta se dividirá en las diferentes secciones que se indican a continuación. Los elementos de la sublista de cada sección propuesta proporcionan más detalles sobre el contenido real que se encontrará en las secciones correspondientes.
Sección Descripción general: Describe la definición, las intenciones y las características del tema base de WordPress de Creative Commons(CC). * Definición: Describe brevemente el tema base de WP de CC. * Intenciones: Describe los objetivos o intenciones del tema base de WP de CC. * Funciones: Describe las funciones del tema base de WP de CC.
Sección de introducción - Requisitos * Describe los requisitos para instalar el tema base de WordPress de CC, es decir, - versión de WordPress - versión de PHP - Composer, etc. - Guía de instalación * Describe cómo los usuarios pueden usar zip para instalar el tema de WordPress de CC * Describe cómo los usuarios pueden comenzar clonando el tema base de WP desde GitHub. * Describir cómo los usuarios pueden instalar dependencias en el proyecto * Explica cómo los usuarios pueden configurar la dependencia Queulat. * Explica cómo los usuarios pueden activar el tema en su entorno de desarrollo local de WordPress.
Guía de uso - Descripción general * Explica el término tema secundario. * Indica las ventajas de usar un tema secundario. * Informa a los usuarios que la forma recomendada de editar el tema WP Base es a través de un tema secundario. * Destaca que el tema base de WP se debe instalar y activar antes de que los usuarios puedan crear un tema secundario.
Usar un tema secundario: Explica cómo los usuarios pueden crear un tema secundario del tema base de WP con un activador. Usa un video para explicar cómo los usuarios pueden crear un tema secundario a partir del activador.
Personalización En las siguientes sub secciones, describimos cómo los usuarios pueden usar el personalizador de WordPress y el panel de administración de WordPress para realizar personalizaciones. También incorporaremos el uso de ilustraciones gráficas para que nuestras descripciones sean más intuitivas. - Personaliza la descripción o el eslogan del sitio. - Menús de navegación personalizados - Personalizar CSS - Agregar páginas - Agregar publicaciones - Widgets - Agregar y quitar widgets del panel de administración de WordPress - Agregar widgets mediante el personalizador con vista previa en vivo
Sección de personalizaciones avanzadas - Sección de personalización de CSS * Describe los componentes que constituyen el diseño del tema: - Vocabulario de CC - Bulma - Sass * Explica cómo se configura Sass en el proyecto. La explicación debe incluir información sobre lo siguiente: (i) La ubicación de los archivos sass en la estructura del proyecto (ii) Las secuencias de comandos de npm que se pueden usar para compilar y observar sass * Explica cómo los usuarios pueden personalizar los estilos de sass en el tema secundario, es decir, a través de la instalación de dependencias específicas de npm. * Explica cómo se usa la clase de componentes (class-component.php) para personalizar los estilos de componentes específicos.
- Sección de hooks
Descripción general
- Explicar el término hooks
- Explica por qué los usuarios deberían aprovechar los hooks.
- Describe los tipos de hooks disponibles.
Cómo usar Acciones
- Lista de las acciones disponibles en el tema WP Base y su posicionamiento
- Explica cómo se pueden implementar estas acciones.
*Usar filtros: Haz una lista de los filtros disponibles en el tema y explica cómo se pueden implementar.
Sección Actualizar el tema: Explica cómo los usuarios pueden actualizar el tema.
Sección sobre licencias * Explica las licencias del proyecto y lo que significa para las personas que quieran usar el tema base CC WP en sus proyectos personales.
Sección de colaboradores * Agrega una guía de colaboradores bien detallada. * Describe el Código de Conducta. * Comunidad: Proporciona información sobre los canales de la comunidad de Creative Commons y cómo pueden participar los colaboradores, etcétera.