Diese Seite enthält die Details zu einem Projekt für technisches Schreiben, das für die Google-Produktsaison von Google Docs akzeptiert wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- Creative Commons
- Technischer Redakteur:
- JackieBinya
- Projektname:
- Nutzungsleitfaden für das WordPress-Basisdesign
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
Während der Bewerbungsphase für GSOD-2020 als technische Redakteurin hatte ich mehrere Interaktionen mit Hugo Solar, dem Mentor des Basis-Dokumentationsprojekts von Creative Commons WordPress.
Bei meinem ersten Kontakt mit ihm suchte ich Hilfe, um die Ziele der Erstellung des Nutzungsleitfadens für das WordPress-Basisdesign zu verstehen. Er war sehr hilfreich und hat mich schnell in das Projekt eingebracht. Bei allen weiteren Interaktionen, die wir danach hatten, ging es darum, die Ziele der Dokumentation für das CC-WordPress Base-Theme zu verfeinern.
Als ich eine Phase erreicht hatte, hatte ich das Gefühl, die Anforderungen und Ziele des Projekts zu verstehen. Dann erstellte ich einen Vorschlag für den CC-WordPress Base Theme Usage Guide.
Der Vorschlag wurde mithilfe der offiziellen Creative Commons-Vorlage für interne Bewerbungen erstellt. Sie enthält Informationen über die Projektzusammenfassung, die vorgeschlagene Projektstruktur und das Layout der neuen Dokumentation für das WordPress-Basisdesign sowie Informationen zu Zeitplänen und Liefergegenständen für die Phase der Dokumenterstellung.
Hugo Solar hat dann meinen Vorschlag geprüft und mir Feedback für Verbesserungen gegeben. Während dieses Prozesses stand er immer für Fragen zum Projekt zur Verfügung.
Ich habe das gegebene Feedback umgesetzt. Mein endgültiger Vorschlag für die Dokumentation zum Erstellen von D&I-Abzeichen ist unter dem Link unten als Google-Dokument verfügbar.
https://docs.google.com/document/d/1XmIsMTLstbhRRSaNFP538YOXJiS0G5QrN6EzuqJfRy4/edit?usp=sharing
Alternativ dazu eine kurze Zusammenfassung meines Vorschlags:
Creative Commons – Leitfaden zur Nutzung des WordPress-Basisthemas Ein Vorschlag von Jacqueline Binya, 28. Juni 2020
Projekt-Synopse Ziel des Projekts ist es, umfassende, intuitive, ansprechende und ansprechend präsentierte Dokumentationen für die Community für das Creative Commons WordPress Base-Theme zu erstellen.
Projektplan Das Problem Derzeit gibt es für das Creative Commons WordPress Base-Theme keine Dokumentation. Es stellt ein Hindernis für die effektive Nutzung des Designs in der Community dar. Mein Ziel ist es, einen vollständigen Nutzungsleitfaden für das Theme zu erstellen und auch Abstraktionen in die aktuelle Codebasis des WP Base-Designs zu implementieren, um die Verwendung des Designs zu vereinfachen.
Die Lösung Sie können futuristische Dokumente mit modernen Frameworks wie Gatsby erstellen. Gatsby hat Auslöser für die Dokumentation zum neuen WordPress-Basisdesign. Ein Beispiel dafür ist der vorkonfigurierte gatsby-gitbook-starter. Er unterstützt Suchmaschinenoptimierung (SEO), Markdown und Algolia ( ein Tool zur Integration für die Suche in statische Websites). Darüber hinaus kann jede von Gatsby generierte Website problemlos für die Integration von Internationalisierung und Barrierefreiheit optimiert werden. Beim Erstellen der Dokumentation habe ich vor, sie so intuitiv wie möglich zu gestalten: - Die Dokumente sollten so verfasst werden, dass sie leicht verständlich sind. Außerdem möchte ich auf Unklarheiten und einen übermäßig komplexen technischen Fachjargon achten. – durch grafische Illustrationen und Medien in die Dokumentation, die als visuelle Lernhilfen dienen. - Verwendung von Beispielen, die zeigen, wie häufige Aufgaben wie etwa Anpassungen ausgeführt werden
Die Abstraktionen, die ich implementieren möchte, wird unter anderem sicherstellen, dass die meisten Kernfunktionen des WP-Basisdesigns, wie z. B. Hooks, von Nutzern über das WordPress-Admin-Steuerfeld verwendet werden können. Darüber hinaus würde ich gerne ein untergeordnetes Starterdesign für das WP-Basisdesign in einem separaten Repository erstellen. Ein untergeordnetes Thema für den Einstieg würde neuen Nutzern ein reibungsloseres und schnelleres Onboarding ermöglichen. Sobald die Dokumentation vollständig und genehmigt ist, wird sie veröffentlicht und online gehostet.
Die vorgeschlagene Struktur des Leitfadens zur Nutzung des CC-WordPress-Basisdesigns – Die vorgeschlagene Dokumentation ist in verschiedene Abschnitte unterteilt, die unten aufgeführt sind. Die Elemente der Unterliste unter jedem vorgeschlagenen Bereich geben dann weitere Details zu den Inhalten an, die in den jeweiligen Abschnitten zu finden sind.
Übersichtsabschnitt – Beschreiben Sie die Definition, die Absichten und die Funktionen des Creative Commons(CC)-WordPress-Basisthemas. * Definition: Beschreiben Sie kurz das CC-WP-Basisthema. * Vorsätze: Ziele und Absichten des „CC WP Base“-Designs skizzieren * Features: Die Funktionen des „CC WP Base“-Designs skizzieren
Abschnitt „Erste Schritte“ – Anforderungen * Anforderungen für die Installation des CC-WordPress-Basisdesigns festlegen (z.B.: – WordPress-Version – PHP-Version – Composer usw. – Installationsanleitung * Erklären, wie Nutzer das CC-WordPress-Theme mithilfe der ZIP-Datei installieren können * Erkläre, wie Nutzer das WP-Basisdesign aus GitHub klonen. * Beschreiben, wie Nutzende Abhängigkeiten im Projekt installieren können. * Erläutern Sie, wie Nutzer die Abhängigkeitsfrage konfigurieren können. * Erklären, wie Nutzer das Theme in ihrer lokalen WordPress-Entwicklungsumgebung aktivieren können
Nutzungsleitfaden – Übersicht * Den Begriff untergeordnetes Thema erklären * Die Vorteile nennen, die sich aus der Verwendung eines untergeordneten Themas ergeben * Informiere die Nutzer darüber, dass zum Bearbeiten des WP Base-Designs ein untergeordnetes Design empfohlen wird. * Hebe hervor, dass das WP-Basisdesign installiert und aktiviert werden muss, bevor Nutzer ein untergeordnetes Design erstellen können.
Untergeordnetes Design verwenden – 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 von Anfang an ein untergeordnetes Design erstellen können.
Anpassung In den unten aufgeführten Unterabschnitten wird beschrieben, wie Nutzer mit der WordPress-Anpassung und dem WordPress-Admin-Steuerfeld Anpassungen vornehmen können. Wir integrieren auch grafische Illustrationen, um unsere Beschreibungen intuitiver zu gestalten. - Anpassen der Website-Beschreibung oder des Slogans - Benutzerdefinierte Navigationsmenüs - CSS anpassen - Seiten hinzufügen - Beiträge hinzufügen - Widgets - Widgets im Admin-Steuerfeld von WordPress hinzufügen - Widgets über die Anpassung mit Live-Vorschau hinzufügen
Abschnitt „Erweiterte Anpassungen“ – Abschnitt „CSS anpassen“ * Beschreiben Sie die Komponenten, die den Stil des Designs ausmachen: – „CC-Vokabular“ – Bulma – Sass * Erklären Sie, wie Sass im Projekt eingerichtet ist. Die Erläuterung sollte folgende Informationen enthalten: (i) Speicherort der SASS-Dateien in der Projektstruktur (ii) npm-Skripts zum Erstellen und Beobachten von Saass * Erklären, wie Nutzer dann die Saass-Stile im untergeordneten Thema anpassen können, z. B. durch die Installation bestimmter npm-Abhängigkeiten * Erläutern Sie, wie die Komponentenklasse (class-component.php) zur Anpassung der Stile bestimmter Komponenten verwendet wird.
- Hakenbereich
Überblick
- Den Begriff Hook erklären
- Erklären Sie, warum Nutzende auf Hooks setzen müssen.
- Skizzieren Sie die verfügbaren Hook-Typen.
Aktionen verwenden
- Verfügbare Aktionen im WP Base-Design und ihre Positionierung auflisten
- Erläutern Sie, wie diese Aktionen implementiert werden können.
*Filter verwenden – Listen Sie die im Design verfügbaren Filter auf und erläutern Sie, wie sie implementiert werden können.
Abschnitt „Design“ aktualisieren – Erläutere, wie Nutzer das Design aktualisieren können.
Abschnitt „Lizenzierung“ * Erläutere die Lizenzierung des Projekts und was es für Personen bedeutet, die das CC WP Base Theme in ihren persönlichen Projekten verwenden möchten.
Abschnitt „Beitragender“ * Detaillierten Leitfaden hinzufügen * Verhaltenskodex skizzieren * Community: Informationen zu den Creative-Commons-Community-Kanälen und zur Teilnahme von Beitragenden usw. bereitstellen