Cette page contient les détails d'un projet de rédaction technique accepté pour la saison des documents Google.
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 (trois mois)
Project description
Lors de la phase de candidature au programme GSOD-2020 pour les rédacteurs techniques, j'ai eu plusieurs interactions avec Hugo Solar, qui est le mentor du projet de documentation du thème de base WordPress Creative Commons.
Lors de mon premier contact avec lui, j'ai demandé de l'aide pour comprendre les objectifs de la création du guide d'utilisation du thème de base WordPress. Il a été très utile et m'a rapidement intégré au projet. Toutes les interactions consécutives que nous avons eues par la suite visaient à affiner les objectifs de la documentation du thème de base WordPress CC.
Quand j'ai atteint un stade, j'ai senti que j'avais compris les exigences et les objectifs du projet, puis j'ai créé une ébauche de proposition pour le guide d'utilisation du thème de base de CC WordPress.
Cette proposition a été élaborée à partir du modèle officiel de Creative Commons pour les candidatures de stagiaires. Il fournit des informations sur le synopsis du projet, la structure proposée et la mise en page de la nouvelle documentation sur le thème de base WordPress, ainsi que des informations sur les délais et les livrables pour la phase de création de documents.
Hugo Solar a ensuite examiné ma proposition préliminaire et m'a donné des commentaires pour m'aider à l'améliorer. Tout au long de ce processus, il a toujours été disponible pour répondre aux questions sur le projet.
J'ai implémenté les commentaires reçus. Ma proposition finale pour la documentation sur la création de badges d'accessibilité et d'inclusion est disponible en tant que document Google Docs sur le lien ci-dessous.
https://docs.google.com/document/d/1XmIsMTLstbhRRSaNFP538YOXJiS0G5QrN6EzuqJfRy4/edit?usp=sharing
Vous trouverez ci-dessous un bref récapitulatif de ma proposition:
Creative Commons – Guide d'utilisation du thème de base WordPress Proposition préparée par Jacqueline Binya, le 28 juin 2020
Présentation du projet L'objectif ultime de ce projet est de créer une documentation riche, intuitive, attrayante et joliment présentée destinée à la communauté pour le thème de base de WordPress Creative Commons.
Plan de projet Problème Actuellement, le thème WordPress Base Creative Commons ne dispose d'aucune documentation. Cela constitue un obstacle à l'utilisation efficace du thème au sein de la communauté. Mon objectif est de créer un guide d'utilisation complet du thème et d'implémenter des abstractions dans le codebase actuel du thème WP Base afin de faciliter son utilisation.
La solution Créez des documents futuristes à l'aide de frameworks modernes tels que Gatsby. Gatsby propose des déclencheurs que nous pouvons utiliser pour amorcer la nouvelle documentation sur le thème de base WordPress. Par exemple, le starter gatsby-gitbook-starter est compatible avec le référencement naturel (SEO), Markdown et Algolia ( un outil utilisé pour intégrer la recherche sur des sites statiques). De plus, n'importe quel site généré par Gatsby peut être facilement optimisé pour intégrer l'internationalisation et l'accessibilité. Lors de la création de la documentation, mes intentions sont de la rendre aussi intuitive que possible en : - rédigeant les documents d'une manière facile à comprendre, en prenant soin d'éviter toute ambiguïté et d'utiliser un jargon technique trop complexe ; - en incluant des illustrations graphiques et des supports multimédias dans la documentation pour les utiliser comme aides visuelles à l'apprentissage. - à l'aide d'exemples qui montrent comment exécuter des tâches courantes (par exemple, des personnalisations).
Les abstractions que j'espère implémenter consistent à s'assurer que les utilisateurs peuvent exploiter la plupart des fonctionnalités de base du thème de base WP, comme les hooks, depuis le panneau d'administration de 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 distinct. Un thème enfant de démarrage offrirait une expérience d'intégration plus fluide et plus rapide aux nouveaux utilisateurs. Une fois la documentation complète et approuvée, elle sera publiée et hébergée en ligne.
Structure proposée du guide d'utilisation du thème de base WordPress CC : la documentation proposée sera divisée en différentes sections listées ci-dessous. Les éléments de la sous-liste figurant dans chaque section proposée donnent plus de détails sur le contenu réel de chaque section.
Section "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écrivez brièvement le thème de base CC WP. * Intentions: décrivez les objectifs/ intentions du thème de base CC WP. * Fonctionnalités: décrivez les fonctionnalités du thème de base CC WP.
Section "Premiers pas" - Exigences * Détaillez les exigences requises pour installer le thème de base WordPress CC, c'est-à-dire : - Version de WordPress - Version de PHP - Composer, etc. - Guide d'installation * Détaillez comment les utilisateurs peuvent utiliser le fichier ZIP pour installer le thème WordPress CC. * Détaillez comment les utilisateurs peuvent commencer en clonant le thème de base WP à partir de GitHub. * Expliquer comment les utilisateurs peuvent installer des dépendances dans le projet. * Expliquez comment les utilisateurs peuvent configurer la requête de dépendance. * Expliquez comment les utilisateurs peuvent activer le thème dans leur environnement de développement WordPress local.
Guide d'utilisation – Présentation * Expliquez le terme "thème enfant". * Indiquez les avantages d'utiliser un thème enfant. * Indiquez aux utilisateurs que la méthode recommandée pour modifier le thème de base WP est d'utiliser un thème enfant. * Soulignez que le thème de base WP doit être installé et activé avant 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 aux utilisateurs comment créer un thème enfant à partir du déclencheur.
Personnalisation Dans les sous-sections ci-dessous, nous expliquons comment les utilisateurs peuvent utiliser le personnaliseur WordPress et le panneau d'administration WordPress pour effectuer des personnalisations. Nous allons également utiliser des illustrations graphiques pour rendre nos descriptions plus intuitives. - Personnalisez la description ou le slogan du site. - Menus de navigation personnalisés - Personnaliser le CSS - Ajouter des pages - Ajouter des articles - Widgets - Ajouter et supprimer des widgets depuis le panneau d'administration WordPress - Ajouter des widgets à l'aide du personnaliseur avec un aperçu en direct
Section "Personnalisations avancées" - Section "Personnalisation du 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 sass dans la structure du projet ; (ii)les scripts npm pouvant être utilisés pour créer et regarder 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 composants (class-component.php) est utilisée pour personnaliser les styles de composants spécifiques.
- Section "Hooks" (Crochets)
Présentation
- Expliquer le terme "hooks"
- Expliquez pourquoi les utilisateurs doivent utiliser des hooks.
- Décrivez les types d'accroches disponibles.
Utiliser des actions
- Liste des actions disponibles dans le thème WP Base et son positionnement
- Expliquez comment ces actions peuvent être mises en œuvre.
*Utilisation des filtres : listez les filtres disponibles dans le thème et expliquez comment ils peuvent être implémentés.
Section "Mettre à jour le thème" - Expliquez comment les utilisateurs peuvent mettre à jour le thème.
Section sur les licences * Expliquez les licences du projet et ce qu'elles signifient pour les personnes qui souhaitent utiliser le thème de base CC WP dans leurs projets personnels.
Section "Contribuer" * Ajoutez un guide détaillé sur la contribution. * Présentez le code de conduite. * Communauté: fournissez des informations sur les canaux de la communauté Creative Commons et sur la façon dont les contributeurs peuvent y participer, etc.