בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.
סיכום הפרויקט
- ארגון קוד פתוח:
- Creative Commons
- כותבים טכניים:
- JackieBinya
- שם הפרויקט:
- מדריך לשימוש בעיצוב הבסיסי של WordPress
- אורך הפרויקט:
- אורך סטנדרטי (3 חודשים)
תיאור הפרויקט
במהלך השלב של הגשת בקשה להוספת כתיבה טכנית ל-GSOD-2020, ניהלתי כמה אינטראקציות עם הוגו סולר (Hugo Solar), שהוא המנטור של פרויקט תיעוד העיצוב הבסיסי ב-Creative Commons ב-WordPress.
בפגישה הראשונה שלנו, ביקשתי עזרה בהבנת המטרות של יצירת המדריך לשימוש בנושאי העיצוב הבסיסיים של WordPress. הוא עזר לי מאוד והסביר לי מה צריך לעשות כדי להשתתף בפרויקט. כל האינטראקציות שקיימנו לאחר מכן היו במטרה לשפר את היעדים של התיעוד של נושא הבסיס של CC WordPress.
כשהגעתי לשלב שבו הרגשתי שהבנתי את הדרישות והיעדים של הפרויקט, המשכתי ליצירת טיוטת הצעה למדריך לשימוש בנושא נושאי בסיס של WordPress ב-CC.
ההצעה נוצרה באמצעות התבנית הרשמית של Creative Commons לבקשות להתמחות. הוא מספק מידע על תקציר הפרויקט, מבנה הפרויקט המוצע והפריסה של מסמכי התיעוד החדש של עיצוב הבסיס ב-WordPress, כמו גם מידע על לוחות הזמנים והתוספות עבור שלב יצירת המסמך.
לאחר מכן, Hugo Solar בדק את טיוטת ההצעה שלי ונתן לי משוב לשיפורים. לאורך התהליך, הוא תמיד היה זמין לענות על שאלות לגבי הפרויקט.
הטמעתי את המשוב שקיבלתי, והצעתי הסופית למסמך העזרה בנושא תגי D&I זמינה בקישור הבא כמסמך ב-Google Docs
https://docs.google.com/document/d/1XmIsMTLstbhRRSaNFP538YOXJiS0G5QrN6EzuqJfRy4/edit?usp=sharing
לחלופין, סיכום קצר של ההצעה שלי מופיע בהמשך:
Creative Commons - מדריך לשימוש בעיצוב בסיסי של WordPress הצעה שהוכנה על ידי ז'קלין ביניה, 28 ביוני 2020
תקציר הפרויקט המטרה העיקרית של הפרויקט היא ליצור מסמכי עזרה עשירים, אינטואיטיביים, מרתקים ומעוצבים היטב לקהילה, עבור ערכת העיצוב הבסיסית של WordPress ב-Creative Commons.
תוכנית Project Plan הבעיה נכון לעכשיו, לעיצוב של Creative Commons WordPress Base אין תיעוד, ולכן הוא מהווה מחסום לשימוש יעיל בעיצוב בקהילה. המטרה שלי היא ליצור מדריך מלא לשימוש בעיצוב ולהטמיע תקצירים ב-codebase הנוכחי של עיצוב WP Base כדי שיהיה קל יותר להשתמש בעיצוב.
הפתרון: יצירת מסמכים עתידניים באמצעות מסגרות מודרניות כמו Gatsby. ב-Gatsby יש ערכות התחלה שאפשר להשתמש בהן כדי להפעיל את התיעוד החדש של ערכת העיצוב הבסיסית של WordPress. דוגמה ל-starter היא gatsby-gitbook-starter, שמגיע עם תמיכה מובנית באופטימיזציה למנועי חיפוש (SEO), ב-Markdown וב-Algolia ( כלי המשמש לשילוב חיפוש באתרים סטטיים). בנוסף, אפשר לבצע בקלות אופטימיזציה של כל אתר שנוצר באמצעות Gatsby כדי לשלב התאמה לשוק הבינלאומי ונגישות. כשאני יוצר את המסמכים, המטרה שלי היא להפוך אותם לאינטואיטיביים ככל האפשר. לשם כך: - אני כותב את המסמכים בצורה פשוטה וברורה, ומשתדל להימנע מבלבול ושימוש במושגים טכניים מורכבים מדי. - על ידי שילוב של איורים וגרפיקה במסמכי העזרה, לצורך שימוש כעזרים חזותיים ללמידה. - באמצעות דוגמאות שממחישות איך לבצע משימות נפוצות, למשל התאמות אישיות.
ההפשטות שאני מקווה להטמיע יכללו הבטחה שרוב הפונקציונליות של ערכת העיצוב הבסיסית של WP, כמו הווידג'טים למשל, יהיו זמינות למשתמשים מחלונית הניהול של WordPress. בנוסף, אשמח ליצור נושא צאצא בסיסי לנושא הבסיסי של WP במאגר נפרד. שימוש בתבנית צאצאית להתחלה יספק למשתמשים חדשים חוויית קליטה חלקה ומהירה יותר. לאחר שהמסמך יושלם ויאושר, הוא יפורסם ויתארח באינטרנט.
המבנה המוצע של מדריך השימוש בנושא נושאי בסיס של WordPress ב-CC - המסמך המוצע יתחלק לקטעים שונים שמפורטים בהמשך. לאחר מכן, פריטי רשימת המשנה מתחת לכל קטע מוצע מספקים פרטים נוספים על התוכן בפועל שיימצא בסעיפים המתאימים.
קטע סקירה כללית – מתאר את ההגדרה, הכוונות והתכונות של ערכת העיצוב הבסיסית של WordPress ב-Creative Commons(CC). * הגדרה: יש לתאר בקצרה את עיצוב הבסיס של CC WP. * כוונות: מתארים את המטרות או הכוונות של נושא הבסיס של CC WP * תכונות: מתארים את התכונות של נושא הבסיס של CC WP
הקטע 'תחילת העבודה' - דרישות * תיאור הדרישות להתקנת עיצוב הבסיס של WordPress ל-CC, כלומר, - גרסת WordPress - גרסת PHP - Composer וכו' - מדריך ההתקנה * כאן מוסבר איך המשתמשים יכולים להשתמש ב-zip כדי להתקין עיצוב ב-CC ל-WordPress. * איך משכפלים את עיצוב הבסיס של WP מ-GitHub? * תארו כיצד משתמשים יכולים להתקין יחסי תלות בפרויקט. * הסבר על האופן שבו משתמשים יכולים להגדיר את יחסי התלות של Queulat. * הסבר על האופן שבו המשתמשים יכולים להפעיל את העיצוב בסביבת הפיתוח המקומית של WordPress.
מדריך לשימוש - סקירה כללית * הסבר על המונח 'עיצוב צאצא' * פירוט היתרונות של שימוש בעיצוב צאצא. * צריך להודיע למשתמשים שהדרך המומלצת לערוך את העיצוב של WP Base היא באמצעות עיצוב צאצא. * חשוב להדגיש שצריך להתקין ולהפעיל את ערכת העיצוב הבסיסית של WP כדי שמשתמשים יוכלו ליצור ערכת עיצוב צאצאת.
שימוש בנושא צאצא – הסבר על האופן שבו משתמשים יכולים ליצור נושא צאצא של נושא הבסיס של WP באמצעות ערכת התחלה. אפשר להשתמש בסרטון כדי להסביר למשתמשים איך ליצור תבנית צאצאית מהתבנית הבסיסית.
התאמה אישית בקטעים המשניים שמפורטים בהמשך, נסביר איך משתמשים יכולים להשתמש ב-WordPress Customizer ובחלונית האדמין של WordPress כדי לבצע התאמות אישיות. אנחנו גם נשתמש באיורים גרפיים כדי שהתיאורים שלנו יהיו אינטואיטיביים יותר. - להתאים אישית את תיאור האתר או שורת התג. - תפריטי ניווט מותאמים אישית - התאמה אישית של CSS - הוספת דפים - הוספת פוסטים - ווידג'טים - הוספה והסרה של ווידג'טים מחלונית הניהול של WordPress - הוספת ווידג'טים באמצעות Customizer עם תצוגה מקדימה בזמן אמת
קטע של התאמות אישיות מתקדמות - קטע של התאמה אישית של CSS * מתארים את הרכיבים שמרכיבים את הסגנון של העיצוב: - CC Vocabulary - Bulma - Sass * מסבירים איך מגדירים את Sass בפרויקט. ההסבר צריך לכלול מידע על: (1) המיקום של קובצי ה-sass במבנה הפרויקט (2) הסקריפטים של npm שאפשר להשתמש בהם כדי ליצור ולעקוב אחרי sass * הסבר על האופן שבו המשתמשים יכולים להתאים אישית את סגנונות ה-sass בתבנית הצאצא, כלומר באמצעות התקנה של יחסי תלות ספציפיים ב-npm * הסבר על האופן שבו משתמשים בכיתה של הרכיב (class-component.php) כדי להתאים אישית את הסגנונות של רכיבים ספציפיים
- הקטע Hooks
סקירה כללית
- תסביר את המונח הוקים
- הסבר למה המשתמשים צריכים להשתמש ב-hooks.
- תיאור של סוגי התוכן המושכים (hooks) הזמינים.
שימוש בפעולות
- הצגת רשימה של הפעולות הזמינות בעיצוב של WP Base והמיקום שלו
- תסביר איך ניתן ליישם את הפעולות האלה.
*שימוש במסננים – הצגת רשימה של המסננים שזמינים בעיצוב והסבר איך להטמיע אותם
הקטע 'עדכון העיצוב' - צריך להסביר איך המשתמשים יכולים לעדכן את העיצוב.
סעיף הרישוי * כאן מוסבר על הרישוי של הפרויקט ומה המשמעות לאנשים שייתכן שירצו להשתמש בעיצוב הבסיס CC WP בפרויקטים האישיים שלהם.
קטע 'שיתוף' * הוספת מדריך מפורט לשיתוף תוכן * סקירה כללית של קוד ההתנהגות * קהילה: מתן מידע על ערוצי הקהילה של Creative Commons ועל האופן שבו שותפים יכולים להשתתף וכו'.