Ta strona zawiera szczegółowe informacje o projekcie polegającym na pisaniu tekstów technicznych, który został zaakceptowany w ramach Google Season of Docs.
Podsumowanie projektu
- Organizacja open source:
- Creative Commons
- Specjalista ds. technicznych:
- JackieBinya
- Nazwa projektu:
- Przewodnik po używaniu podstawowego motywu WordPress
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
W fazie aplikacji na stanowisko technicznego copywritera w ramach GSOD 2020 miałem kilka kontaktów z Hugo Solarem, który jest mentorem w projekcie dokumentacji motywów bazowych WordPressa Creative Commons.
Podczas pierwszego kontaktu z nim szukałem pomocy w zrozumieniu celów tworzenia przewodnika po korzystaniu z podstawowego motywu WordPressa. Był bardzo pomocny i szybko zacząłem pracować nad projektem. Wszystkie kolejne interakcje, które odbyliśmy w późniejszym czasie, dotyczyły doprecyzowania celów dokumentacji motywu CC WordPress Base.
Gdy doszłam do etapu, na którym czułam się na tyle pewnie, że rozumiem wymagania i cele projektu, stworzyłam projekt propozycji podręcznika CC WordPress Base Theme Usage Guide.
Propozycja została przygotowana za pomocą oficjalnego szablonu Creative Commons dla aplikacji dla stażystów. Zawiera on informacje o synopsisie projektu, proponowanej strukturze projektu i układzie nowej dokumentacji podstawowego motywu WordPress, a także informacje o harmonogramie i wymaganiach dotyczących fazy tworzenia dokumentu.
Hugo Solar sprawdził moją wersję roboczą propozycji i przekazał mi opinię, dzięki której mogłem wprowadzić poprawki. W trakcie całego procesu zawsze był dostępny, aby odpowiadać na pytania dotyczące projektu.
Wprowadziliśmy zmiany opisane w opinii. Ostateczna wersja dokumentacji dotyczącej przyznawania certyfikatów D&I jest dostępna w pliku Google Docs pod tym linkiem.
https://docs.google.com/document/d/1XmIsMTLstbhRRSaNFP538YOXJiS0G5QrN6EzuqJfRy4/edit?usp=sharing
Poniżej znajdziesz krótkie podsumowanie mojej propozycji:
Creative Commons – przewodnik po podstawowym motywie WordPressa Propozycja przygotowana przez Jacqueline Binya, 28 czerwca 2020 r.
Opis projektuOstatecznym celem tego projektu jest stworzenie bogatej, intuicyjnej, angażującej i pięknie przedstawionej dokumentacji dla społeczności na temat motywu podstawowego WordPressa Creative Commons.
Plan projektu Problem Obecnie motyw WordPress Base z Creative Commons nie ma dokumentacji, co utrudnia jego skuteczne wykorzystanie w społeczności. Moim celem jest stworzenie pełnego przewodnika po tym motywie oraz implementacja abstrakcji w bieżącej wersji kodu źródłowego motywu WP Base, aby ułatwić jego używanie.
Rozwiązanie Twórz futurystyczne dokumenty przy użyciu nowoczesnych platform, takich jak Gatsby. Gatsby ma startery, których możemy użyć do zainicjowania nowej dokumentacji podstawowego motywu WordPress. Przykładem startera jest gatsby-gitbook-starter, który jest wyposażony w obsługę optymalizacji witryn pod kątem wyszukiwarek (SEO), markdowna i Algolii ( narzędzie do integracji wyszukiwania w witrynach statycznych). Ponadto każdą witrynę utworzoną za pomocą Gatsby można łatwo zoptymalizować pod kątem międzynarodowości i dostępności. Podczas tworzenia dokumentacji staram się, aby była ona jak najbardziej intuicyjna: - piszę w prosty sposób, unikając niejasności i używania zbyt skomplikowanego żargonu technicznego. – przez włączenie do dokumentacji ilustracji graficznych i multimediów do wykorzystania jako wizualne pomoce w nauce. – korzystanie z przykładów, które pokazują, jak wykonywać typowe czynności, np.dostosowywać.
Chciałbym w tym celu zapewnić, że większość z podstawowych funkcji motywu podstawowego WP, takich jak hooki, jest wykorzystywana przez użytkowników z poziomu panelu administracyjnego WordPress. Chciałbym też utworzyć w oddzielnym repozytorium podstawowy motyw potomny dla motywu WP Base Theme. Dzięki temu nowi użytkownicy będą mogli szybciej i łatwiej zapoznać się z tematem. Po jej ukończeniu i zatwierdzeniu dokumentacja zostanie opublikowana i hostowana online.
Proponowana struktura przewodnika po podstawowym szablonie WordPressa w CC - Proponowana dokumentacja będzie podzielona na sekcje wymienione poniżej. Elementy podlisty w każdej proponowanej sekcji zawierają więcej informacji o rzeczywistej zawartości, która będzie się znajdować w odpowiednich sekcjach.
Sekcja Omówienie - Opisz definicję, intencje i funkcje motywu podstawowego WordPressa na licencji Creative Commons(CC). * Definicja: krótko opisz motyw WP Base CC. * Zamierzenia: przedstaw cele i zadania głównego motywu CC WP. * Funkcje: przedstaw funkcje motywu podstawowego CC WP.
Sekcja „Pierwsze kroki” – wymagania * Omówienie wymagań dotyczących instalacji podstawowego motywu CC WordPress, – wersji PHP, – narzędzia Composer itp. – Przewodnik instalacji * Omówienie sposobu, w jaki użytkownicy mogą zainstalować motyw CC WordPress, * opisać, jak rozpocząć klonowanie motywu podstawowego WP z GitHuba. * Opisz, jak użytkownicy mogą zainstalować zależności w projekcie. * Wyjaśnij, jak użytkownicy mogą skonfigurować zależność Queulat. * Wyjaśnij, jak użytkownicy mogą aktywować motyw w lokalnym środowisku programistycznym WordPress.
Przewodnik użytkownika - Omówienie * Wyjaśnij, czym jest motyw podrzędny. * Wymień zalety korzystania z motywu podrzędnego. * Poinformuj użytkowników, że zalecanym sposobem edytowania motywu bazowego WP jest użycie motywu podrzędnego. * Podkreśl, że zanim użytkownicy będą mogli utworzyć motyw potomny, motyw podstawowy WP musi zostać zainstalowany i aktywowany.
Korzystanie z motywu podrzędnego – wyjaśnij, jak użytkownicy mogą utworzyć motyw podrzędny motywu podstawowego WP za pomocą polecenia inicjującego. Użyj filmu, aby wyjaśnić, jak użytkownicy mogą utworzyć motyw potomny na podstawie motywu startowego.
Dostosowywanie W podrozdziałach wymienionych poniżej opisujemy, jak użytkownicy mogą korzystać z WordPress Customizer i panelu administracyjnego WordPress, aby wprowadzać zmiany. Aby opisy były bardziej intuicyjne, zaczniemy też stosować ilustracje. – dostosuj opis witryny lub slogan. – Niestandardowe menu nawigacyjne – Dostosowywanie CSS – Dodawanie stron – Dodawanie postów – Widżety – Dodawanie i usuwanie widżetów w panelu administracyjnym WordPress – Dodawanie widżetów za pomocą narzędzia Dostosuj z podglądem na żywo
Sekcja dotycząca zaawansowanych dostosowań - Sekcja dotycząca dostosowywania szablonu CSS * Opisz komponenty, które tworzą styl motywu: - Słownik CC - Bulma - Sass * Wyjaśnij, jak skonfigurować Sass w projekcie. Wyjaśnienie powinno zawierać informacje o: (i) lokalizacji plików sass w strukturze projektu (ii) skryptach npm, których można użyć do tworzenia i oglądania sassów * wyjaśnić, jak użytkownicy mogą następnie dostosować style sass w motywie podrzędnym, np. przez instalację określonych zależności npm; * wyjaśnić, jak klasa komponentu (class-component.php) jest używana do dostosowywania stylów poszczególnych komponentów.
- Sekcja „Zdania przyciągające uwagę”
Przegląd
- Wyjaśnij terminy „elementy haka”
- Wyjaśnij, dlaczego użytkownicy powinni korzystać z punktów styczności.
- Opisz dostępne typy haka.
Korzystanie z działań
- Wymień działania dostępne w motywie WP Base i jego pozycjonowanie
- Wyjaśnij, jak można wdrożyć te działania.
*Korzystanie z filtrów – sporządź listę filtrów dostępnych w motywie i wyjaśnij, jak można je stosować.
Sekcja dotycząca aktualizowania motywu - Wyjaśnij, jak użytkownicy mogą zaktualizować motyw.
Sekcja dotycząca licencjonowania * Wyjaśnij, jakie licencje dotyczą projektu i co oznaczają dla osób, które chcą używać motywu CC WP Base Theme w swoich projektach osobistych.
Sekcja poświęcona * Dodaj dobrze szczegółowy przewodnik * Opracuj kodeks postępowania * Społeczność: podaj informacje o kanałach społeczności Creative Commons i o tym, jak mogą w nich uczestniczyć itp.