Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- Creative Commons
- Rédacteur technique:
- JackieBinya
- Nom du projet:
- Guide d'utilisation du thème de base WordPress
- Durée du projet:
- Durée standard (3 mois)
Project description
Pendant la phase de candidature en tant que rédacteur technique du GSOD-2020, j'ai eu plusieurs interactions avec Hugo Solar, qui est le mentor du projet de documentation des thèmes de base de Creative Commons pour WordPress.
Lors de mon premier contact avec lui, j'ai cherché à comprendre les objectifs de la création du guide d'utilisation du thème de base de WordPress. Il m'a été très utile et m'a rapidement permis de m'impliquer dans le projet. Toutes les interactions consécutives que nous avons eues ensuite ont consisté à affiner les objectifs de la documentation sur le thème WordPress Base de CC.
Une fois arrivé à une étape, j'ai eu l'impression de comprendre les exigences et les objectifs du projet. J'ai ensuite créé une ébauche de proposition pour le guide d'utilisation du thème de base WordPress CC.
La proposition a été élaborée à l'aide du modèle officiel de Creative Commons pour les candidatures de stagiaire. Il fournit des informations sur le synopsis du projet, la structure proposée du projet et la mise en page de la nouvelle documentation du thème de base WordPress, ainsi que des informations sur les calendriers et les produits livrables pour la phase de création du document.
Hugo Solar a ensuite examiné mon brouillon de proposition et m'a donné son avis afin de l'améliorer. Tout au long de ce processus, il a toujours été disponible pour répondre aux questions sur le projet.
J'ai appliqué les commentaires transmis, et ma proposition finale concernant la création de badges D&I est disponible via le lien ci-dessous sous forme de document Google Docs
https://docs.google.com/document/d/1XmIsMTLstbhRRSaNFP538YOXJiS0G5QrN6EzuqJfRy4/edit?usp=sharing
Vous trouverez également ci-dessous un bref résumé de ma proposition:
Creative Commons - Guide d'utilisation du thème de base de WordPress Proposition préparée par Jacqueline Binya, 28 juin 2020
Présentation du projet Le but ultime de ce projet est de créer une documentation riche, intuitive, engageante et magnifiquement présentée à l'attention de la communauté pour le thème de base Creative Commons de WordPress.
Plan du projet Le problème Actuellement, le thème WordPress Base de Creative Commons ne dispose d'aucune documentation. Cela constitue un obstacle à son utilisation efficace au sein de la communauté. Mon objectif est de créer un guide d'utilisation complet pour le thème et d'implémenter des abstractions dans le codebase actuel du thème WP Base afin de faciliter l'utilisation du thème.
La solution Créez des documents futuristes à l'aide de frameworks modernes tels que Gatsby. Gatsby dispose de déclencheurs que nous pouvons utiliser pour amorcer la nouvelle documentation sur le thème de base WordPress. Par exemple, gatsby-gitbook-starter est un modèle prêt à l'emploi. Il est compatible avec le référencement naturel (SEO), Markdown et Algolia ( un outil utilisé pour intégrer la recherche dans les sites statiques). De plus, tout site généré par Gatsby peut facilement être optimisé pour intégrer l'internationalisation et l'accessibilité. En créant cette documentation, j'ai l'intention de la rendre aussi intuitive que possible : - rédige les documents de manière facile à comprendre, en veillant à éviter toute ambiguïté et l'utilisation d'un jargon technique trop complexe. - en intégrant des illustrations graphiques et des médias dans la documentation afin de les utiliser comme supports visuels pour l'apprentissage. - Utiliser des exemples qui montrent comment exécuter des tâches courantes, comme les personnalisations.
Les abstractions que je souhaite implémenter consisteront à s'assurer que les utilisateurs peuvent exploiter la plupart des fonctionnalités de base du thème de base WP, comme les hooks, à partir du panneau d'administration WordPress. En outre, j'aimerais créer un thème enfant de démarrage pour le thème de base WP dans un dépôt séparé. Avoir un thème enfant de départ offrirait une expérience d'intégration plus fluide et plus rapide aux nouveaux utilisateurs. Une fois la documentation complétée et approuvée, elle est publiée et hébergée en ligne.
Structure proposée pour le guide d'utilisation du thème de base WordPress dans CC : La documentation proposée sera divisée en différentes sections répertoriées ci-dessous. Sélectionnez ensuite une sous-liste pour chaque section proposée afin de fournir plus de détails sur le contenu réel qui se trouve dans les sections correspondantes.
Section de présentation - Décrivez la définition, les intentions et les fonctionnalités du thème de base WordPress Creative Commons(CC). * Définition: décrire brièvement le thème de base de CC WP. * Intentions: décrire les buts et les intentions du thème de base de CC WP * Fonctionnalités: décrire les fonctionnalités du thème de base CC WP
Section "Getting Started" - Conditions requises * Décrivez les conditions requises pour installer le thème de base WordPress CC en clonant le thème de base WP depuis GitHub. * Décrire comment les utilisateurs peuvent installer des dépendances dans le projet. * Expliquer comment les utilisateurs peuvent configurer Queulat des dépendances * Expliquer comment les utilisateurs peuvent activer le thème dans leur environnement de développement WordPress local
Guide d'utilisation - Présentation * Expliquer le terme thème enfant * Expliquer les avantages de l'utilisation d'un thème enfant * Informez les utilisateurs qu'il est recommandé d'utiliser un thème enfant pour modifier le thème de base WP. * Soulignez le fait que le thème de base WP doit être installé et activé pour que les utilisateurs puissent créer un thème enfant.
Utiliser un thème enfant - Expliquez comment les utilisateurs peuvent créer un thème enfant du thème de base WP à l'aide d'un déclencheur. Utilisez une vidéo pour expliquer comment les utilisateurs peuvent créer un thème enfant à partir du déclencheur.
Personnalisation Dans les sous-sections listées ci-dessous, nous expliquons comment les utilisateurs peuvent effectuer des personnalisations à l'aide du personnalisateur WordPress et du panneau d'administration WordPress. Nous allons également intégrer des illustrations graphiques pour rendre nos descriptions plus intuitives. - Personnalisez la description du site ou le slogan. - Menus de navigation personnalisés - Personnaliser CSS - Ajouter des pages - Ajouter des posts - Widgets - Ajouter et supprimer des widgets dans le panneau d'administration WordPress - Ajouter des widgets à l'aide du personnalisateur avec aperçu en direct
Section "Personnalisations avancées" - Personnaliser CSS * Décrivez les composants qui constituent le style du thème : - Vocabulaire CC - Bulma - Sass * Expliquez comment Sass est configuré dans le projet. L'explication doit inclure les informations suivantes : (i) L'emplacement des fichiers npm dans la structure du projet (ii) Scripts npm pouvant être utilisés pour créer et surveiller sass * Expliquer comment les utilisateurs peuvent ensuite personnaliser les styles sass dans le thème enfant (par exemple, en installant des dépendances npm spécifiques) * Expliquer comment la classe de composant (class-component.php) est utilisée pour personnaliser les styles de composants spécifiques
- Section des crochets
Présentation
- Expliquer le terme "hooks"
- Expliquez pourquoi les utilisateurs devraient exploiter les hooks.
- Décrivez les types de hooks disponibles.
Utiliser des actions
- Listez les actions disponibles dans le thème de base de WP et son positionnement
- Expliquez comment ces actions peuvent être mises en œuvre.
*Utilisation de filtres - Listez les filtres disponibles dans le thème et expliquez comment les mettre en œuvre.
Mise à jour de la section des thèmes : expliquez aux utilisateurs comment mettre à jour le thème.
Section "Gestion des licences" * Expliquez les licences du projet et ce qu'elles signifient pour les personnes qui pourraient vouloir utiliser le thème de base CC WP dans leurs projets personnels.
Section dédiée * Ajoutez un guide de contribution bien détaillé * Décrivez le code de conduite * Communauté: fournissez des informations sur les chaînes de la communauté Creative Commons, la façon dont les contributeurs peuvent participer, etc.