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