דף זה מכיל את הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Google Docs.
סיכום הפרויקט
- ארגון הקוד הפתוח:
- Creative Commons
- כתב טכני:
- JackieBinya
- שם הפרויקט:
- מדריך לשימוש בעיצוב הבסיסי של WordPress
- אורך הפרויקט:
- אורך רגיל (3 חודשים)
תיאור הפרויקט
במהלך השלב של הגשת בקשות לכותבים טכניים ב-GSOD-2020, היו לי מספר אינטראקציות עם Hugo Solar, המנטור של פרויקט התיעוד של Creative Commons ב-WordPress.
בפנייה הראשונית איתו, חיפשתי עזרה בהבנת המטרות של יצירת המדריך לשימוש בעיצוב הבסיס של WordPress. הוא עזר לי מאוד והצטרף אותי לפרויקט תוך זמן קצר. כל האינטראקציות הרציפות שניהלנו לאחר מכן עסקו בשיפור המטרות של תיעוד הנושא של נושא הבסיס של WordPress ב-CC.
כשהגעתי לשלב שבו הרגשתי שהבנתי את הדרישות והמטרות של הפרויקט, יצרתי טיוטה של טיוטה למדריך השימוש בעיצוב הבסיסי של WordPress.
ההצעה נוצרה באמצעות התבנית הרשמית של 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.
תכנון פרויקט הבעיה בשלב זה, לעיצוב הבסיס של Creative Commons אין תיעוד, והדבר מהווה מחסום לשימוש יעיל של העיצוב בקהילה. המטרה שלי היא ליצור מדריך שימוש מלא לעיצוב וגם להטמיע הפשטות ב-codebase הנוכחי של עיצוב ה-WP Base כדי שיהיה קל יותר להשתמש בו.
הפתרון יצירת מסמכים עתידניים באמצעות מסגרות מודרניות כמו גטסבי. Gatsby מציע כלים שיעזרו לנו להתחיל לעבוד עם התיעוד החדש של העיצוב הבסיסי של WordPress. דוגמה לתחילת פעולה היא ה-Gatsby-gitbook- Starter, שיוצא מהקופסה ומופעל עם תמיכה באופטימיזציה עבור מנועי חיפוש (SEO), Markdown ו-Aolgolia ( כלי המשמש לשילוב חיפוש באתרים סטטיים). בנוסף לכך, ניתן לשפר בקלות כל אתר שנוצר על ידי גטסבי כך שישלב התאמה בינלאומית ונגישות. כשיוצרים את התיעוד, כוונתי היא להפוך אותו לאינטואיטיבי ככל האפשר. כדי לעשות זאת: - לכתוב את המסמכים בשפה מובנת, ולהימנע מעמימות ומשימוש בז'רגון טכני מורכב מדי. - על ידי שילוב איורים גרפיים ומדיה במסמכים המשמשים כעזרים חזותיים ללמידה. - שימוש בדוגמאות שממחישות איך לבצע משימות נפוצות, כמו התאמות אישיות.
ההפשטות שאני מקווה ליישם יכללו להבטיח שמשתמשים מחלונית הניהול של WordPress יוכלו להשתמש ברוב הפונקציונליות העיקרית של עיצוב הבסיס של WP, כמו הוספת תוכן הוק (hooks). בנוסף, אשמח ליצור ערכת צאצא למתחילים עבור העיצוב של WP במאגר נפרד. שימוש בעיצוב צאצא למתחילים יספק למשתמשים חדשים חוויית הצטרפות חלקה ומהירה יותר. לאחר השלמת המסמכים ואישורם, הם יפורסמו ויתארחו באינטרנט.
המבנה המוצע של המדריך לשימוש בעיצוב הבסיסי של WordPress - המסמכים המוצעים יחולקו לקטעים שונים שמפורטים בהמשך. הפריטים ברשימות המשנה שמתחת לכל קטע מוצע מספקים פרטים נוספים על התוכן בפועל שיימצא בקטעים המתאימים.
קטע הסקירה הכללית - תארו את ההגדרה, הכוונות והתכונות של עיצוב הבסיס של WordPress Creative Commons(CC). * הגדרה: יש לתאר בקצרה את העיצוב הבסיסי של CC WP. * כוונות: תארו את המטרות או הכוונות של עיצוב הבסיס של CC WP * תכונות: הציגו את התכונות של העיצוב הבסיסי CC WP
הקטע 'איך מתחילים' - דרישות * צריך לפרט את הדרישות להתקנת עיצוב הבסיס של WordPress, כלומר - גרסת WordPress - גרסת PHP - Composer וכו' - מדריך התקנה * Outline כיצד משתמשים יכולים להשתמש ב-zip כדי להתקין עיצוב של WordPress ב-CC * Outline כיצד משתמשים יכולים להתחיל על ידי שכפול העיצוב הבסיסי של WP מ-GitHub. * הסבירו איך המשתמשים יכולים להתקין יחסי תלות בפרויקט. * הסבר על האופן שבו משתמשים יכולים להגדיר Queulat של תלות. * להסביר כיצד משתמשים יכולים להפעיל את העיצוב בסביבת הפיתוח המקומית שלהם ב-WordPress.
מדריך שימוש - סקירה כללית * הסבר על המונח נושא צאצא * הסבר על יתרונות השימוש בעיצוב צאצא. * יש ליידע את המשתמשים שהדרך המומלצת לערוך את עיצוב הבסיס של WP היא באמצעות עיצוב צאצא. * להדגיש את העובדה שצריך להתקין ולהפעיל את עיצוב הבסיס של WP כדי שהמשתמשים יוכלו ליצור עיצוב צאצא.
שימוש בעיצוב ילדים - להסביר איך משתמשים יכולים ליצור עיצוב צאצא של עיצוב הבסיס של WP באמצעות סימן לתחילת פעולה. כדאי להשתמש בסרטון כדי להסביר איך משתמשים יכולים ליצור עיצוב צאצא מהסימן לתחילת פעולה.
התאמה אישית בקטעי המשנה המפורטים בהמשך, נתאר כיצד משתמשים יכולים להשתמש בפרמטר להתאמה אישית של WordPress ובחלונית הניהול של WordPress כדי לבצע התאמות אישיות. נשלב גם שימוש באיורים גרפיים כדי להפוך את התיאורים שלנו לאינטואיטיביים יותר. - להתאים אישית את תיאור האתר או שורת התגים. - תפריטי ניווט בהתאמה אישית - התאמה אישית של CSS - הוספת דפים - הוספת פוסטים - ווידג'טים - הוספה והסרה של ווידג'טים מחלונית הניהול של WordPress - הוספת ווידג'טים באמצעות פרמטר להתאמה אישית עם תצוגה מקדימה בזמן אמת
הקטע 'התאמות אישיות מתקדמות' - התאמה אישית של קטע CSS * יש לתאר את הרכיבים שמרכיבים את סגנון העיצוב: - אוצר מילים בעותקים - Bulma - Sass * הסבר על האופן שבו Sass מוגדר בפרויקט. ההסבר צריך לכלול מידע על: (א) המיקום של קובצי sass במבנה הפרויקט (ii) הסקריפטים של npm שניתן להשתמש בהם כדי לבנות ולצפות ב-sass * להסביר איך משתמשים יכולים להתאים אישית את סגנונות ה-sass בעיצוב הצאצא, כלומר על ידי התקנה של יחסי תלות ספציפיים של npm * הסבר על האופן שבו נעשה שימוש במחלקת הרכיב (class-component.php) כדי להתאים אישית את הסגנונות (class-component.php)
- קטעי הוק
סקירה כללית
- הסבירו את המונח 'הוקים'
- מסבירים למה המשתמשים צריכים למנף את ה-hooks.
- יש לתאר את סוגי הווים הזמינים.
שימוש בפעולות
- פירוט הפעולות הזמינות בעיצוב הבסיס של WP והמיקום שלו
- הסבירו כיצד ניתן ליישם את הפעולות האלה.
*שימוש במסננים - פירוט המסננים הזמינים בעיצוב והסבר כיצד ניתן ליישם אותם
עדכון הקטע של העיצוב - הסבר על האופן שבו משתמשים יכולים לעדכן את העיצוב.
קטע הרישוי * הסבר על הרישוי של הפרויקט ומה המשמעות שלו לאנשים שאולי ירצו להשתמש בעיצוב הבסיסי של CC WP בפרויקטים האישיים שלהם.
קטע של תורם תוכן * הוספת מדריך מפורט בצורה מפורטת * תאר את קוד ההתנהגות * קהילה: ספק מידע על ערוצי הקהילה של Creative Commons ועל האופן שבו תורמים יכולים להשתתף, וכדומה.