Diese Seite enthält die Details zu einem Projekt für technische Angelegenheiten, das für die Google-Saison der Dokumente angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- Creative Commons
- Technischer Redakteur:
- JackieBinya
- Projektname:
- Anleitung zur Verwendung des WordPress-Basisthemas
- Projektdauer:
- Standardlänge (3 Monate)
Projektbeschreibung
Während der Bewerbungsphase als technischer Redakteur für die GSOD-2020 hatte ich mehrere Interaktionen mit Hugo Solar, dem Mentor des Dokumentationsprojekts zum Basisthema von Creative Commons auf WordPress.
Bei meinem ersten Kontakt mit ihm wollte ich wissen, welche Ziele mit der Erstellung des Leitfadens zur Verwendung des WordPress-Basisthemas verfolgt werden. Er war sehr hilfsbereit und hat mich schnell in das Projekt einbezogen. Bei allen nachfolgenden Interaktionen ging es darum, die Ziele der Dokumentation des CC WordPress Base-Designs zu verfeinern.
Als ich der Meinung war, die Anforderungen und Ziele des Projekts verstanden zu haben, habe ich einen Entwurf für die Nutzungsanleitung für das CC-WordPress-Basis-Design erstellt.
Der Vorschlag wurde mit der offiziellen Creative Commons-Vorlage für interne Anwendungen erstellt. Es enthält Informationen zur Projektübersicht, zur vorgeschlagenen Projektstruktur und zum Layout der neuen Dokumentation des WordPress-Base-Designs sowie Informationen zu Zeitplänen und zu den Arbeitsergebnissen für die Phase der Dokumenterstellung.
Hugo Solar hat dann meinen Entwurf geprüft und mir Feedback zur Verbesserung gegeben. Während des gesamten Prozesses stand er immer zur Verfügung, um Fragen zum Projekt zu beantworten.
Ich habe das Feedback berücksichtigt und mein endgültiger Vorschlag für die Dokumentation der D&I-Kennzeichnungen ist im Link unten als Google-Dokument verfügbar.
https://docs.google.com/document/d/1XmIsMTLstbhRRSaNFP538YOXJiS0G5QrN6EzuqJfRy4/edit?usp=sharing
Alternativ finden Sie hier eine kurze Zusammenfassung meines Vorschlags:
Creative Commons – Leitfaden zur Verwendung von WordPress-Basisthemen Vorschlag von Jacqueline Binya, 28. Juni 2020
Projektbeschreibung Das ultimative Ziel dieses Projekts ist es, eine umfassende, intuitive, ansprechende und ansprechend präsentierte Dokumentation für die Community für das Creative Commons-WordPress-Basis-Design zu erstellen.
Projektplan Das Problem Derzeit gibt es für das WordPress-Basis-Theme von Creative Commons keine Dokumentation, was eine effektive Nutzung des Themas innerhalb der Community erschwert. Mein Ziel ist es, einen vollständigen Nutzungsleitfaden für das Thema zu erstellen und auch Abstraktionen in die aktuelle Codebasis des WP Base-Themes zu implementieren, um die Verwendung des Designs zu erleichtern.
Die Lösung Mit modernen Frameworks wie Gatsby futuristische Dokumente erstellen. Gatsby bietet Auslöser, mit denen wir die Dokumentation des neuen WordPress-Base-Themes erstellen können. Ein Beispiel für einen Starter ist der „gatsby-gitbook-starter“, der standardmäßig Unterstützung für Suchmaschinenoptimierung (SEO), Markdown und Algolia bietet ( ein Tool zur Integration der Suche in statische Websites). Darüber hinaus kann jede mit Gatsby erstellte Website problemlos für die Integration von Internationalisierung und Zugänglichkeit optimiert werden. Meine Absichten beim Erstellen der Dokumentation sind, sie so intuitiv wie möglich zu gestalten. Dazu muss ich die Dokumente auf leicht verständliche Weise schreiben und darauf achten, Unklarheiten und übermäßig komplexe technische Fachjargon zu vermeiden. – indem grafische Illustrationen und Medien in die Dokumentation aufgenommen werden, die als visuelle Hilfe für das Lernen verwendet werden. – mit Beispielen, die zeigen, wie häufige Aufgaben ausgeführt werden, z. B. Anpassungen.
Die Abstraktionsschichten, die ich implementieren möchte, sollen unter anderem dafür sorgen, dass die meisten Hauptfunktionen des WP Base-Designs wie Hooks beispielsweise vom WordPress-Admin-Bereich aus genutzt werden können. Außerdem würde ich gerne ein Starter-Unterthema für das WP Base Theme in einem separaten Repository erstellen. Ein Start-Child-Theme würde das Onboarding für neue Nutzer vereinfachen und beschleunigen. Sobald die Dokumentation vollständig ist und genehmigt wurde, wird sie veröffentlicht und online gehostet.
Die vorgeschlagene Struktur des CC WordPress Base Theme Usage Guide: Die vorgeschlagene Dokumentation wird in die unten aufgeführten Abschnitte unterteilt. Die Unterlistenelemente unter den einzelnen vorgeschlagenen Abschnitten enthalten dann weitere Details zum Inhalt der jeweiligen Abschnitte.
Abschnitt „Übersicht“: Hier sollten Sie die Definition, die Absichten und die Funktionen des Creative Commons-WordPress-Basis-Designs beschreiben. * Definition: Beschreiben Sie das CC WP Base Theme kurz. * Zwecke: Die Ziele und Absichten des CC-WP-Basisthemas skizzieren * Funktionen: die Funktionen des CC-WP-Basisthemas beschreiben
Abschnitt „Einstieg“ – Anforderungen * Anforderungen für die Installation des CC-WordPress-Basis-Designs angeben, z.B.: – WordPress-Version – PHP-Version – Composer usw. – Installationsanleitung * Erläutern, wie Nutzer das CC-WordPress-Design mithilfe einer ZIP-Datei installieren können * Erläutern, wie Nutzer mit dem Klonen des WP-Basis-Designs von GitHub beginnen können. * Skizzieren, wie Nutzende Abhängigkeiten im Projekt installieren können * Beschreiben Sie, wie Nutzer Abhängigkeitswarteschlangen konfigurieren können. * Erläutern Sie, wie Nutzer das Design in ihrer lokalen WordPress-Entwicklungsumgebung aktivieren können.
Nutzungsleitfaden – Übersicht * Begriff „Untergeordnetes Design“ erklären * Vorteile der Verwendung eines untergeordneten Designs angeben * Nutzer darüber informieren, dass das WP Base-Design am besten über ein Child-Theme bearbeitet wird. * Hervorheben, dass das WP-Basis-Design installiert und aktiviert werden muss, bevor Nutzer ein untergeordnetes Design erstellen können.
Verwenden eines untergeordneten Designs – Erläutere, wie Nutzer mithilfe eines Auslösers ein untergeordnetes Design des WP-Basisdesigns erstellen können. Erläutern Sie in einem Video, wie Nutzer ein untergeordnetes Design aus dem Starter erstellen können.
Anpassung In den unten aufgeführten Unterabschnitten wird beschrieben, wie Nutzer mit der WordPress-Anpassung und dem Admin-Steuerfeld von WordPress Anpassungen vornehmen können. Außerdem werden wir grafische Illustrationen verwenden, um unsere Beschreibungen intuitiver zu gestalten. – Websitebeschreibung oder Slogan anpassen – Benutzerdefinierte Navigationsmenüs – CSS anpassen – Seiten hinzufügen – Beiträge hinzufügen – Widgets – Widgets über das WordPress-Admin-Dashboard hinzufügen und entfernen – Widgets über den Customizer mit Live-Vorschau hinzufügen
Abschnitt „Erweiterte Anpassungen“ – Abschnitt „CSS anpassen“ * Beschreiben Sie die Komponenten, aus denen das Design des Designs besteht: – CC Vocabulary – Bulma – Sass * Erläutern Sie, wie Sass im Projekt eingerichtet wird. Die Erklärung sollte folgende Informationen enthalten: (i) Der Speicherort der SASS-Dateien in der Projektstruktur (ii) Die npm-Scripts, mit denen SASS erstellt und beobachtet werden kann * Erläutern Sie, wie Nutzer die SASS-Stile im untergeordneten Design anpassen können, z. B. durch die Installation bestimmter npm-Abhängigkeiten. * Erläutern Sie, wie die Komponentenklasse (class-component.php) verwendet wird, um die Stile bestimmter Komponenten anzupassen.
- Abschnitt „Hooks“
Übersicht
- Den Begriff „Hooks“ erklären
- Erläutern Sie, warum Nutzer Anreize nutzen sollten.
- Beschreiben Sie die verfügbaren Arten von Hooks.
Aktionen verwenden
- Listen Sie die im WP Base-Design verfügbaren Aktionen und ihre Positionierung auf.
- Erläutern Sie, wie diese Aktionen umgesetzt werden können.
*Filter verwenden: Nennen Sie die im Design verfügbaren Filter und erläutern Sie, wie sie implementiert werden können.
Aktualisieren des Bereichs für das Design – Erläutere, wie Nutzer das Design aktualisieren können.
Lizenzierung * Erläutern Sie die Lizenzierung des Projekts und was sie für Nutzer bedeutet, die das CC WP Base Theme in ihren persönlichen Projekten verwenden möchten.
Abschnitt zur Mitwirkung * Einen ausführlichen Leitfaden für Mitwirkende hinzufügen * Verhaltenskodex skizzieren * Community: Informationen zu den Creative Commons-Community-Kanälen und dazu, wie Mitwirkende teilnehmen können usw.