השלב הנוכחי:
הוכרזו התוצאות. אפשר לראות
את ציר הזמן.
תוכלו להיעזר בדוגמה הזו כדי ליצור מקרה לדוגמה משלכם.
PicklePlus: תיעוד הכלי לתרומה Glorious Pickle
ארגון או פרויקט: כאן יש לקשר לאתר הראשי של הארגון או הפרויקט שלך Glorious Pickle
תיאור הארגון: Glorious Pickle (גרסה נוכחית 1.2.3, גרסה ראשונה ב-2009) היא ספרייה עם רישיון MIT שמאפשרת לחשב בקלות את היחס המושלם בין מלח, סוכר, חומץ ותבלינים לכל ירק שניתן לחמץ, בכמויות שנעות מתינוק בודד מלפפון בודד ועד מטעני חמאה.
מחברים: אופציונלי: אפשר לציין את שמות המחברים של המקרה לדוגמה. אם תתבקשו לעשות זאת, השתמשו בשמות המשתמשים
הצהרת בעיה/תקציר הצעה
איזו בעיה ניסית לפתור באמצעות תיעוד חדש או משופר? אם אפשר, יש לקשר לדף ההצעה באתר הפרויקט.
הוספת מרכיבים למסד הנתונים של רכיבי הכלי Glorious Pickle היא משימה מורכבת שגוזלת זמן רב, ואין לכלי תיעוד טוב. להרבה אנשים שמוסיפים תוכן אין ניסיון בשימוש ב-Git או בשליחת בקשות משיכה. המשמעות היא שב-Glorious Pickle יש פערים משמעותיים בנתוני הרכיבים, והכלי שלנו פחות שימושי. על ידי שיפור התיעוד בנושא הוספת מרכיבים חדשים, אנחנו מקווים לעודד תורמים חדשים ולעודד עוד שיטות לכבישים!
תיאור הפרויקט
יצירת ההצעה
מה דעתך על ההצעה שלך לעונה של Google Docs? באיזה תהליך השתמש הארגון שלך כדי להחליט על רעיון? איך ביקשתם ושילבתם משוב?
אנשי Glorious PickleDocs SIG שמעו על 'העונה של Google' בתוכנית Google Docs באמצעות ציוץ מ'המשרד לתוכניות קוד פתוח' של Google. צוות SIG דן בתוכנית בפגישה הדו-שבועית שלה והסכים ליצור הצעה. שניים מהחברים ב-SIG (@KimChiCook and @Dillicious) התנדבו לעבוד על טיוטת ההצעה לבדיקה בפגישה הבאה.
לאחר ש- PickleDocs SIG הסכים לטיוטה של ההצעה, נשלח אימייל אל פרויקט רחב יותר וביקש משוב. ארבעה-עשר חברי קהילה הציעו משוב, ביניהם @GloriousChooselePat, המנהלת של ממשק ה-API להוספת רכיבים. @GloriousCollectlePat התנדבה להיות מקור מידע במהלך התוכנית.
לאחר דיון ושילוב המשוב שהתקבל, ההצעה נשלחה אל ועדת ההיגוי של פרויקט Glorious Pickle להצבעה. כל חמשת החברים ב-GPPSC הצביעו על +1 להגשת ההצעה והבקשה, ו- @VinegarViv הסכימו לעזור ביצירת חשבון Open Collective הנדרש להשתתפות בתוכנית ולפיקוח על התשלומים.
תקציב
הוספת קטע קצר על התקציב. איך הערכת את העבודה? האם היו הוצאות בלתי צפויות? האם בסופו של דבר הוצאת פחות מסכום המענק? האם הקציתם את הכספים כמו שצריך או האם הקציתם חלק גדול יותר/פחות/מיותר? האם השתמשת בכספים אחרים מחוץ לעונה של Google Docs?
שניים מהחברים GloriousChoosele PickleDocs SIG עבדו ככותבים טכניים (אחד באירופה והשני בארגנטינה). הם עזרו לנו להעריך את העבודה ולמצוא תקציבים לפרויקטים דומים, תוך השוואה בין טיוטות העבודה שהם עשו בעבר. בנוסף, נשארו לנו 1,000 דולר ארה"ב במימון בלתי מוגבל במסגרת תוכנית PicklePals משנת 2019 שהקצינו לפרויקט.
הוצאה בלתי צפויה עזרה לכותב הטכני שלנו להשכיר נקודת Wi-Fi לשיתוף אינטרנט, עקב שריפות שהיו באזור שנפגע משריפות ואיבד את הגישה לאינטרנט בבית שלו. בסופו של דבר שלחנו למשתתפים פחות חולצות טי-שרט ממה שתכננו, כך שהתוצאה הייתה מאוזנת.
בנוסף, החלטנו לפצות את אחת התורמית ב-Glorious Pickle, @Piccalily (שהייתה בעבר עורכת תוכן מקצועית במסגרת חייה ללא בוררות) כדי לעזור בהעתקה ובביצוע הגהה של המסמכים שנוצרו על ידי הכותב הטכני.
משתתפים
מי עבד על הפרויקט הזה (השתמש בשם המשתמש אם ביקשו את המשתתפים)? איך מצאת את הכותב הטכני שלך ושכרת את שירותיו? איך מצאת מתנדבים אחרים או משתתפים בתשלום? אילו תפקידים היו להם? האם מישהו נטש? מה למדתם על גיוס, תקשורת וניהול פרויקטים?
הצוות העיקרי שעבד על הפרויקט הזה היה:
- @Dillicious, @KimChiCook (PickleDocs SIG)
- @Piccalily (copyeditor)
- @GherKen, @VinegarViv (עזרה של אדמינים, GPPSC)
- @BBChips, @GloriousChooselePat (מומחים לנושא הנדון)
- סאם סקריב (כותב טכני)
מצאנו את סאם Scribe ברשימת העונה של Google Docs ב-GitHub. חשבנו שהניסיון שלהם (סאם עבד על כתב עת קולינרי כמו גם על כתיבת תיעוד עבור אתרים) מתאים מאוד לפרויקט שלנו. סאם הצטרף לשיחה השבועיים של PickleDocs SIG ושוחח איתנו על הפרויקט, תוך הצעת מספר הצעות חשובות ששילבנו בהצעה. יצרנו גם קשר עם שני כותבים טכניים אחרים המוכרים לנו דרך הרשתות של חברות SIG, אך שניהם לא היו זמינים במהלך תקופת התוכנית.
מאחר שאזור הזמן של עידו היה חופף רק שעות ספורות עם רוב החברים ב- PickleDocs SIG, שלחנו שיחה בפורום הדיונים שלנו ל- Picklers שהיו באזור הזמן של Sam והכירו את תהליך הוספת הרכיבים. @BBChips התנדבו לענות על שאלות בשביל עידו ולעזור לו למצוא מומחים אחרים לפי הצורך. @Glorious PicklePat גם התנדב לעזור לסאם להבין את הארכיטקטורה הבסיסית של הכלי ואת הודעות השגיאה האפשריות מ-API, וסיפק עזרה מ-GitHub ו-Git.
למרבה הצער, באמצע התוכנית @VinegarViv נאלצו לסגת מהפרויקט מסיבות אישיות. חבר GPPSC @GherKen הגביר את הטיפול בשאלות ניהוליות ובנושא תשלומים.
אחרי שלא ענו על כמה שאלות (Glorious Pickle משתמש במופע חינמי של Slack, ומדי פעם הדיון זז מהר כל כך שהשיחות נעשות בגלל מגבלת הארכיון), למדנו שעלינו לשמור רשימה של שאלות פעילות במסמך משותף (השתמשנו במסמך משותף של Google Docs). חברי PickleDocs SIG בדקו את המידע לפני כל פגישה והקפידו לקבל תשובות לפני סיום הפגישה. סער יכול לפנות ישירות אל @BBChips לגבי שאלות דחופות.
שמחנו מאוד לעבוד עם סאם וסאם, בנוסף לעדכון התיעוד של Glorious Pickle, הפכו למלקטים נלהבים בעצמם!
ציר הזמן
לתת סקירה כללית קצרה של ציר הזמן של הפרויקט (יש לציין את תאריך הסיום המשוער או את אבני הדרך בתהליך אם הפרויקט נמשך).
בזמן שהמתנו לעונת Google Docs כדי להכריז על הארגונים המשתתפים בתוכנית, חברי PickleDocs SIG חיפשו כל עבודה קודמת שחשבנו שהיא תהיה שימושית לסאם. במהלך חודש, גילינו כמה הערות ממאמץ קודם לעדכן את המסמכים שנעצרו, ועבדנו גם על חלקים מחומרי הביקורת לעריכת תוכן תקופתי במאגר הפתוח של Google Docs.
ברגע שקיבלנו את החדשות הטובות שנבחרנו לעונה של Google Docs, סם ו- PickleDocs SIG נפגשו ועבדו על לוח זמנים כללי:
| במה | הושלם על ידי |
|---|---|
| בדיקת מסמכים | 7 במאי |
| תרחישים לדוגמה של יומן חיכוך 3 | 14 במאי |
| אפשר לבדוק את יומני החיכוך באמצעות @Glorious PicklePat ו- @BBChips, כדי לענות על שאילתות | 28 במאי |
| תרחיש לדוגמה 1 של טיוטה ראשונה של מסמכים מעודכנים | 25 ביוני |
| טיוטה מס' 1 של התרחיש נבדק על ידי @Glorious PicklePat ו- @KimChiCook | 2 ביולי |
| תרחיש לדוגמה 2: טיוטה ראשונה של מסמכים מעודכנים | 2 ביולי |
| טיוטת התרחיש השני נבדקה על ידי @Glorious PicklePat ו- @Dillicious | 9 ביולי |
| תרחיש לדוגמה 3 של טיוטה ראשונה של מסמכים מעודכנים | 9 ביולי |
| תרחיש לדוגמה מס' 3 נבדק על ידי @Dillicious ו-@KimChiCook | 16 ביולי |
| תשובות לכל השאילתות בכל תרחישי השימוש | 30 ביולי |
| רוב אנשי PickleDocs SIG היו בחופשה בין 1 ל-20 באוגוסט | -- |
| התחלת בדיקה של מסמכים חדשים בקהילה (מסמכים שפורסמו כטיוטות באתר Glorious Pickle) | 21 באוגוסט |
| כולל משוב לבדיקה | 10 בספטמבר |
| העתקה והגהה של מסמכים חדשים | 17 בספטמבר |
| סטטוס טיוטה של מסמכים הוסר, מסמכים הושקו באופן רשמי | 28 בספטמבר |
| תהליך עדכון המסמכים שנוצרו | 1 בנובמבר |
| המקרה לדוגמה הזה נוצר | 8 בנובמבר |
| מקרה לדוגמה נשלח | 16 בנובמבר |
בתקציב ההצעה שלנו, הערכנו שהכותב הטכני יקדיש 10-15 שעות בשבוע לעבודה על הפרויקט שלנו. עידו שמר רישומים לגבי זמן השימוש, וממוצע שעות ו-11.5 שעות בשבוע.
תוצאות
מה נוצר, עודכן או השתנה בדרך אחרת? אם יש קישורים למסמכים שפורסמו, יש לכלול אותם. האם היו דברים שנכללים בהצעה שלא נוצרו? ציינו גם אותם.
שלושה מקרי שימוש עיקריים תועדו כמדריכים מלאים למשתמש:
איך להוסיף מרכיב חדש ל-Glorious Pickle
איך מוסיפים וריאנט מרכיב ב-Glorious Pickle
איך מעדכנים או מתקנים מרכיב ב-Glorious Pickle
כדי להקל על הוספת התוכן, המדריכים האלה כללו גם תבניות חדשות של בקשות משיכה.
בנוסף, במהלך הפרויקט סאם יצר מילון מונחים קטן של Pickle של מונחים שלמדו, שפורסם גם באתר הפרויקט Glorious Pickle.
הוספנו הוראות לעדכון המדריכים למשתמש האלה ל-wiki של הפרויקט.
כללנו גם כמה תקצירים לתורמים חדשים ל-GitHub, שיעזרו להם להשתמש בתהליכים ובכלים שלנו. אחרי שבדקנו את המשאבים הזמינים, יכולנו פשוט לכתוב את 'תקציר' של פרויקט אחר.
מדדים
אילו מדדים בחרת למדוד את הצלחת הפרויקט? הצלחתם לאסוף את המדדים האלה? האם הייתה התאמה טובה או נמוכה בין המדדים לבין התוצאות שרציתם עבור הפרויקט? האם המדדים שלך השתנו מאז ההצעה?
בהצעה שלנו, הצענו שני מדדים:
- מספר בקשות המשיכה שקשורות לרכיבים
- מספר בקשות המשיכה מתורמים חדשים
בחודש ספטמבר (החודש המלא הראשון מאז הפרסום של טיוטת התיעוד) זיהינו עלייה של 5% בבקשות משיכה הקשורות למרכיבים (מ-20 באוגוסט ל-21 בספטמבר), וראינו שלושה תורמי תוכן חדשים ששלחו ארבע בקשות משיכה בסך הכול (לעומת שני תורמים חדשים ששלחו שתי בקשות משיכה באוגוסט). אנחנו מתכננים לעקוב אחר המדדים האלה מדי חודש.
החל מ-1 בינואר, נתחיל לעקוב גם אחרי מספר הכותבים שתרמו יותר משלוש תרומות בסך הכל, החל מרבעוני לאחר פרסום התיעוד.
אנו סבורים שתיעוד חדש זה שינה את היכולת של תורמים חדשים להוסיף למסד הנתונים של GloriousCollectle — תורם תוכן חדש אחד הזכיר בהערה של יחסי הציבור שלו שהוא ניסו בעבר, אך לא השלים את העדכון מכיוון שהוא לא הבין את התהליך.
ניתוח
מה עבד בצורה טובה? מה לא היה צפוי? עם אילו מכשולים או בעיות נתקלת? האם לדעתך הפרויקט שלך מוצלח? למה או למה לא? (אם עדיין מוקדם מדי, הסבירו מתי אתם מצפים שתוכלו להעריך את הצלחת הפרויקט שלכם).
אנחנו מאוד מרוצים מתוצאות הפרויקט 'עונת Google' ב-Docs ומחשיבים אותו כהצלחה. התיעוד החדש ברור ומועיל, וכבר ראינו עלייה מסוימת במספר בקשות המשיכה הקשורות למרכיבים ובמספר בקשות המשיכה מתורמים חדשים.
שמחנו גם שכמעט כל קהילת Glorious Pickle השתתפה, באמצעות משוב על ההצעה המקורית ועל ידי בדיקת המסמכים החדשים בצורת טיוטה.
התמודדנו עם כמה מכשולים בלתי צפויים – היינו מודים על כך שהשריפות במדינה של סאם לא גרמו נזק נוסף מהפסקת החשמל באינטרנט! בנוסף, הצטערנו לאבד את @VinegarViv מהפרויקט. אנחנו מאחלים לה ולמשפחתה כל טוב ומקווים לראות אותה שוב בקרוב.
אחד הדברים שלא הבנו עד שרון התחיל לעבוד על התיעוד היה כמה מונחים וראשי תיבות לא מוכרים למי שנכנס לפרויקט שלנו ללא רקע של כבישה. עם זאת, עידו הקפיד לנהל רשימה של כל המונחים הלא מוכרים, והגדיר אותם בעזרת מחקר ולבקש מחברי הקהילה הסברים והפניות. מילון המונחים פיקל זה יעזור מאוד לקבל בברכה אנשים נוספים לקהילת הכבישים בעתיד.
סיכום
סכם את חוויית הפרויקט ב-2-4 פסקאות. הדגישו את מה שלמדתם ומה הייתם בוחרים לעשות אחרת בעתיד. אילו עצות היית נותן לפרויקטים אחרים שמנסים לפתור בעיה דומה באמצעות תיעוד?
במילה אחת, החווייה שלנו הייתה מעולה! השגנו את כל מה שעזרנו בתיעוד שלנו ונראה שהמדדים שלנו תואמים ליעדים שלנו.
חלק עצום מהצלחת הפרויקט הזה היה מזל שעבדנו עם הכותב הטכני שלנו, סם סריב. [אני לא כתבתי את זה - סאם] אף על פי לסאם לא היה רקע בחריגה או ניסיון בעבודה עם GitHub, ככותב טכני מנוסה, הוא הרגיש בנוח לצלול לתחום חדש של נושאים, לשאול שאלות ולבצע מחקר. סאם קולט במהירות לא רק את הכלים שלנו לפרויקט (אנחנו משתמשים בלוח קנבן כדי לעקוב אחרי העבודה) אלא גם את בדיחות החמוצים שלנו! אנחנו שמחים מאוד שרון גילה את החרקים של הכבישה וש'עבשנו' אותם בקהילה שלנו.
אנחנו ממליצים לפרויקטים אחרים:
- צמצם את מספר ההצעות כדי שיהיה קל לנהל אותן. (במקור רצינו לכלול תיעוד לשימוש במעריך שלנו עם מכונות כבישה תעשייתיות באצווה בהצעה שלנו, והשמטנו אותו רק מפני שאחת מחברי הקהילה המעורבת במידה רבה במכונות מלפפונים בקוד פתוח תכתוב את תזה לדוקטורט שלה במהלך התוכנית). בסופו של דבר, קיבלנו מספיק עבודה כדי להעסיק את סאם!
- נצלו את הרשתות שלכם כשאתם מחפשים כותבים טכניים. כדאי לבקש המלצות מכל חברי הקהילה. מצאנו את סאם בעונת Google Docs ב-GitHub, אבל תמיד ידענו שאפשר לעבוד איתו כי שוחחנו עם כמה אנשים במהלך תקופת הבקשה.
- ברוכים הבאים לקהילה של הכותב הטכני שלכם! סאם סיפר לנו שהגישה הנלהבה של GloriousChooselers עזרה לנו לשאול שאלות.
- עזרו לכותבים הטכניים שלכם לרכוש מיומנויות בקוד פתוח. סם אף פעם לא השתמש ב-Git, אבל אחרי שעברו על כמה מדריכים הם הגיעו בקצב מהיר. בהתחלה עידו חשש בנוגע לכמות המשוב שהמשתמשים עשויים לקבל מהקהילה ומהי הדרך שבה אפשר לשלב אותו, אבל מודל הקונצנזוס בקהילה שלנו (כשמדובר בהסכמה מתקבלת כאשר כל הבעיות מטופלות, אבל לא בהכרח מקבלים מענה) גרם לסאם לטפל בביקורות באמצעות מומחיות הכתיבה הטכנית שלו.
נספח
אם יש לך חומרים אחרים שהיית רוצה לקשר אליהם (לדוגמה, אם יצרת חוזה עבודה עם כותב טכני שברצונך לשתף, תבניות לפרויקט התיעוד או מקורות מידע פתוחים אחרים, אפשר לפרט ולקשר אותם כאן). הנספח גם מיועד להוספת קישורים לכלי תיעוד או למשאבים שבהם השתמשת, וכן להוספת תודות או תודות שאולי לא מתאימות לסעיפים שלמעלה.
אימות חתימות
הצוות שלנו רוצה להודות לאנשים ולדברים הבאים:
- @Dillicious רוצה להודות לשותף שלה וגם לתחנת רדיו היפ-הופ דל-פי
- @KimChiCook רוצה להודות ל-할머니 שלו על כך שהוא מלמד איך למלפפונים חמוצים
- @Piccalily רוצה להודות למדריך הסגנון של שיקגו באינטרנט
- @GherKen רוצה להודות לשלושת הילדים שלו על כך שאכלו את כל החמוצים שהוא יכול להכין
- @VinegarViv רוצה להודות לשאר הצוות על האירוח של עזיבתה
- @BBChips רוצים להודות על האוכל הכי טוב שאפשר לקבל, 'חטיפי הקרמל של Tunnock'
- @Glorious PicklePat רוצה להודות ל- PickleDocs SIG על שיתוף הפעולה בפרויקט
- סאם Scribe רוצה להודות לכל קהילת GloriousChoosele, אבל במיוחד לקטלרים ששלחו להם צנצנות שימורים במהלך המחסור בצנצנות במהלך קיץ 2021, והתחילו את הדרך להרבה חמוצים טעימים!