דף זה מכיל את הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Google Docs.
סיכום הפרויקט
- ארגון הקוד הפתוח:
- The Linux Foundation
- כתב טכני:
- xiaoya
- שם הפרויקט:
- יצירת מסמכים לפרויקט התגים של CHAOSS D&I
- אורך הפרויקט:
- אורך רגיל (3 חודשים)
תיאור הפרויקט
מיקדתי את התוכן העיקרי כאן: המטרות העיקריות הן העשרת העבודה הקשורה למסמכים בתוך תהליך העבודה, כתיבת תיעוד של תגי D&I מול הקהילה ואירוח תיעוד רב-לשוני שמעובד בפלטפורמה מיוחדת. את המסמכים האלה אפשר להפריד למשימות המיקרו הבאות: לעדכן ולשלב את תבנית ה-PR הנוכחית באמצעות מדדי D&I נוספים ומגוון השאלות. נסח סקירה כללית של מושגים כדי להציג את תוכנית התיוג של D&I נסח את הנחיות האפליקציה באמצעות מסמכי JOSS כסימוכין נסח את ההנחיות לבודקים באמצעות מסמכי JOSS כחומר עזר מסמך הסבר על התפקידים השונים ותחומי האחריות השונים לאורך תהליך העבודה. מסמך שמסביר איך משתמשים חדשים ב-GitHub מיושמים בתהליך העבודה הנחיה לתורמים שמראה איך משתמש חדש יכול לתרום את הפרויקט או את המסמך. עזרו בתרגום מסמכים, בדקו את ביצועי התרגום האוטומטי במיוחד בסינית והשתמשו בתרגום ידני אם יש צורך בכך. ארגנו את התיעוד בפורמט רב-שפות בהתאם לעבודת התרגום. לאירוח המסמך ב-Gitbook , Read the Docs או GitHub Wiki.
תוכן להצגה 1. אתם יכולים להעשיר את הפרויקט ואת תבנית ה-PR לאירוע באמצעות מדדים נוספים ומגוון שאלות. המסמך הזה כולל את כל העבודה הקשורה למסמכים בתהליך העבודה, ובמיוחד תבנית ה-PR שהוכנה שהמועמדים ישלימו. זהו החלק העיקרי של תהליך העבודה לדעתי, מכיוון שהוא ממלא תפקיד מכריע בהערכת הבודקים, כך שהטופס והתוכן של השאלות יושלכו במהלך יצירת תהליך העבודה, ואני אעבור על הדברים הבאים:
תוכן להצגה 2. בהמשך מופיעה טיוטה של מבנה התיעוד הפונה לקהילה
סקירה כללית של תג D&I
מבוא
ליעד
רמות התג
הגשת בקשה לקבלת תג
הגשת בקשה לתג אירוע
תבנית PR של האירוע
הגשת בקשה לתג פרויקט
תבנית PR של הפרויקט
בדיקה
איך אפשר להפוך לבודק
דוגמאות לעמידה בדרישות של מנהל ניגוד תחומי עניין
בדיקת קריטריוני PR-ביקורת על תפקידים ובדיקת PR-הגשת בקשות
רשימה חלקית של כותבי בקשות ובדיקות-PR
תוכן להצגה 3. אפשר לארגן את המסמכים בפורמט רב-לשוני ולארח אותם בפלטפורמות כמו 'קריאת המסמכים' או Gitbook.
בתהליך העבודה הנוכחי, חלק מתהליכי התרגום האוטומטי נבדקים. אני אעזור לבדוק עד כמה התוצאה של התרגום מבוצעת במיוחד בסינית, למשל תקינות ורהיטות התרגום. המסמך יהיה בפורמט הזה, אבדוק את פלטפורמות האירוח של מסמכים טכניים כמו 'קריאת המסמכים', 'Gitbook' ו-'wiki' של Gitbook, ואבחר את הפלטפורמה המתאימה ביותר לאירוח התיעוד הפתוח של הקהילה.