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:
- 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 del GSOD-2020, tuve varias interacciones con Hugo Solar, que es el mentor del proyecto de documentación temática base de WordPress de Creative Commons.
En mi contacto inicial con él, pedí ayuda para comprender los objetivos de crear la guía de uso del tema básico de WordPress. Fue muy útil y me ayudó a comenzar el proyecto en poco tiempo. Todas las interacciones consecutivas que tuvimos después estaban relacionadas con definir mejor los objetivos de la documentación del tema de WordPress Base de CC.
Cuando llegué a una etapa, sentí que comprendí los requisitos y objetivos del proyecto, así que creé un borrador de la propuesta para la Guía de uso del tema básico de WordPress en CC.
La propuesta se creó usando la plantilla oficial de Creative Commons para las solicitudes para pasantes. Proporciona información sobre el resumen del proyecto, la estructura del proyecto propuesto y el diseño de la documentación del nuevo tema base de WordPress, así como información sobre los plazos y las entregas para la fase de creación del documento.
Luego, Hugo Solar, revisó mi borrador de propuesta y me brindó comentarios para realizar mejoras. Durante este proceso, siempre estuvo disponible para responder preguntas sobre el proyecto.
Implementé los comentarios recibidos, y mi propuesta final para la creación de insignias de D&I está disponible en el siguiente vínculo como un documento de Google.
https://docs.google.com/document/d/1XmIsMTLstbhRRSaNFP538YOXJiS0G5QrN6EzuqJfRy4/edit?usp=sharing
A su vez, un breve resumen de mi propuesta, que se encuentra a continuación:
Creative Commons: Guía de uso del tema básico de WordPress Propuesta preparada por Jacqueline Binya, 28 de junio de 2020
Sinopsis del proyecto El objetivo final de este proyecto es crear documentación rica, intuitiva, atractiva y con una presentación atractiva para el tema básico de WordPress para Creative Commons.
Plan del proyecto El problema Actualmente, el tema base de WordPress de Creative Commons no tiene documentación, esto actúa como una barrera para la utilización efectiva 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 documentación del nuevo tema base de WordPress. Un buen ejemplo es el inicio de gatsby-gitbook-starter, que viene listo para usar y que incluye compatibilidad con la optimización por motores de búsqueda (SEO), Markdown y Algolia ( una herramienta que se utiliza para integrar las búsquedas en sitios estáticos). Además, cualquier sitio generado por Gatsby se puede optimizar fácilmente para integrar la internacionalización y la accesibilidad. Al crear la documentación, mis intenciones son hacerlo lo más intuitivo posible: - Escribir los documentos de una manera fácil de entender y tener cuidado de evitar la ambigüedad y el uso de jerga técnica excesiva y compleja. - incorporando ilustraciones gráficas y medios en la documentación para usarlos como recursos visuales para el aprendizaje. - usar ejemplos que demuestren cómo ejecutar tareas comunes, p. ej., las personalizaciones.
Las abstracciones que espero implementar incluirán garantizar que los usuarios puedan aprovechar la mayor parte de la funcionalidad principal del tema base de WP, como los hooks, desde el panel de administración de WordPress. Además, me encantaría crear un tema secundario inicial para el tema base 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 la documentación esté completa y aprobada, se publicará y alojará en línea.
La estructura propuesta de la Guía de uso del tema básico de WordPress en CC - La documentación propuesta se dividirá en diferentes secciones que se enumeran a continuación. Los elementos de la sublista en cada sección propuesta luego brindan más detalles sobre el contenido real que se podrá encontrar en las secciones correspondientes.
Sección de descripción general : Describe la definición, las intenciones y las funciones del tema básico de WordPress(CC) de Creative Commons. * Definición: Describe brevemente el tema base de CC WP. * Intenciones: Describir los objetivos o las intenciones del tema base de CC WP. * Funciones: Describir las funciones del tema base de CC WP.
Sección de introducción - Requisitos * Describe los requisitos para instalar el tema base de WordPress en 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 * Explicar cómo los usuarios pueden configurar la dependencia Queulat * Explicar 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 el hecho de que el tema base WP se debe instalar y activar antes de que los usuarios puedan crear un tema secundario.
Uso de un tema secundario : Explica cómo los usuarios pueden crear un tema secundario del tema base WP con un activador. Usa un video para explicar cómo los usuarios pueden crear un tema secundario desde el comienzo.
Personalización En las subsecciones que se indican a continuación, 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. - Personalizar 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 administrador de WordPress - Agregar widgets con el personalizador con vista previa en vivo
Sección Personalización avanzada - Cómo personalizar la sección CSS * Describe los componentes que constituyen el estilo del tema: - Vocabulario en campo Cc - Bulma - Sass * Explica cómo se organiza 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 mirar sass * Explicar cómo los usuarios pueden personalizar los estilos de sass en el tema secundario, es decir, mediante la instalación de dependencias específicas de npm * Explicar cómo se usa la clase de componente (class-component.php) para personalizar los estilos de componentes específicos
- Sección de ganchos
Descripción general
- Explicar el término trampas
- Explica por qué los usuarios tendrían que aprovechar los ganchos.
- Describe los tipos de hooks disponibles.
Cómo usar acciones
- Enumerar las acciones disponibles en el tema WP Base y su posicionamiento
- Explica cómo se pueden implementar estas acciones.
*Uso de filtros: Haz una lista de los filtros disponibles en el tema y explica cómo se pueden implementar.
Sección de actualización del tema: explica cómo los usuarios pueden actualizar el tema.
Sección de licencias * Explica las licencias del proyecto y qué significa para las personas que quieran usar el tema base CC WP en sus proyectos personales.
Sección de contribución * Agrega una guía de contribución 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.