השלב הנוכחי:
תוכנית 'עונת 2020 של Docs' הסתיימה ב-15 במרץ 2021. אפשר לראות
את ציר הזמן.
דף זה מכיל רמזים לכותבים טכניים איך להשלים את החלקים העיקריים באפליקציה להשתתפות בעונה של Docs. המידע הזה יעזור לכם להבין מהם הגורמים שארגוני קוד פתוח עשויים לקחת בחשבון כשהם בוחרים את הפרויקטים הטכניים לכתיבה שהם רוצים להדריך בעונה של Docs.
מבוא
ההנחיות שבהמשך חלות בדרך כלל על עונה של Docs. לכל ארגון קוד פתוח יכולים להיות קריטריונים ספציפיים להערכה. תוכלו ליצור קשר עם כל אחד מהארגונים המשתתפים לפני שליחת הבקשה, כדי לדון בדרישות שלהם ולתכנן את ההצעה לפרויקט. כדאי לעיין בשלב של ניתוח הכותב הטכני שמתואר במדריך לכתיבה טכנית.
טופס הבקשה
טופס הבקשה זמין במדריך הטכני לכתיבה בשלב הבקשה לכתיבה טכנית.
לאחר שליחת הטופס, תוכלו להמשיך לעדכן את המידע בטופס עד לסיום השלב של הגשת הבקשה לכותבים טכניים (9 ביולי 2020).
מידע אישי
טופס הבקשה כולל את הפרטים האישיים הבאים:
השם שלכם: יש לציין את השם המלא. העונה של Docs לא תשתף את השם הזה עם ארגוני הקוד הפתוח והשם לא יפורסם בו באתר.
שם תצוגה לבחירתכם: עליכם לציין את השם שבו אתם רוצים להשתמש כמזהה ציבורי במהלך ההשתתפות בעונה של Docs. מומלץ מאוד לא להשתמש בשם המלא והאמיתי בתור השם המוצג. שם התצוגה ב-Docs ישותף עם ארגון הקוד הפתוח שציינתם בטופס הבקשה. במהלך העונה של Docs, השם המוצג שלכם יופיע באתר ברשימת הפרויקטים הנתמכים לכתיבה טכנית.
כתובת האימייל: מזינים את כתובת האימייל שמשויכת לחשבון Google. (נדרש חשבון Google כדי להשתתף בעונה של Docs. אפשר להשתמש בחשבון Google בכתובת אימייל שאינה של Gmail. מומלץ לעיין במאמר העזרה הזה). בעונה של Docs נעשה שימוש בכתובת האימייל שלכם כדי ליצור איתכם קשר ולהפוך את משאבי האתר לזמינים עבורכם. כתובת האימייל הזו ב-Docs תשותף עם ארגון הקוד הפתוח שציינתם בטופס הבקשה. העונה של Docs לא תפרסם את כתובת האימייל הזו באתר.
בהמשך מוסבר איך משתמשים במידע מטופס הבקשה בקטע 'עונה של Google'.
מידע על הניסיון שלכם בכתיבה טכנית
כשהחונכים ומנהלי הארגון בקוד פתוח בוחנים הצעה לפרויקט, הם מתעניינים בידע הטכני שלכם בכתיבה. תוכלו לספק בטופס את הפרטים הבאים:
חוויית כתיבה טכנית מהזמן האחרון: עד שלוש רשומות שבהן ניתן לפרט את תפקידי הכתיבה הטכניים או הניסיון התעסוקתי שלכם מהזמן האחרון. אם יש לכם ניסיון של תיעוד בקוד פתוח, כדאי לכלול אותו גם כאן. תסכם את התפקיד שלכם, את תחומי האחריות של התפקיד ואת העבודה שביצעתם. אפשר לציין תאריכים במקרים הרלוונטיים.
קישור לקורות חיים או לקורות חיים: (אופציונלי). כתובת ה-URL של גרסה נגישה לציבור של קורות החיים או קורות החיים (CV).
קישור לעבודות לדוגמה: (אופציונלי) כתובת האתר של אוסף דוגמאות של היצירה שנגיש לציבור, או קישורים בודדים לדוגמאות של היצירה שלך.
כל דבר נוסף שהיית רוצה להוסיף: (אופציונלי.) כל מידע שתרצו להוסיף לאפליקציה. לדוגמה, העניין שלכם במסמכים טכניים, למה אתם רוצים להשתתף בעונה של Docs או כל ניסיון רלוונטי אחר.
הצעה לפרויקט
ההצעה לפרויקט היא סיכום של עבודת התיעוד שהייתם רוצים להשלים תוך כדי עבודה עם ארגון הקוד הפתוח שבחרתם בעונת Docs.
ניתן לשלוח עד שלוש הצעות לפרויקטים. כל ההצעות לפרויקטים חייבות להיות באותו טופס בקשה.
הקדישו זמן על הצעת הפרויקט שלכם ושימו לב להנחיות הבאות.
עבודת הכנה:
עליכם לעיין ברשימת ארגוני הקוד הפתוח המשתתפים ולבחור ארגון אחד או יותר שמעניינים אתכם. עיינו ברעיונות לפרויקטים שהציעו כל אחד מארגוני הקוד הפתוח שבחרתם.
אם בארגון שמעניין אתכם לא הציעו רעיונות כלשהם, תוכלו לבחון את הרשימה הגנרית של הרעיונות לפרויקטים ולבסס את הרעיון שלכם על אחד מהרעיונות האלה. תוכלו גם לחשוב על רעיון משלכם, גם אם הארגון פרסם רעיונות וגם אם לא.
אתם יכולים לפנות לאחד או יותר מהארגונים המשתתפים כדי לדון ברעיונות לפרויקטים. כדי ליצור קשר, השתמשו בכתובת האימייל של הארגון שמופיעה ברשימת הארגונים המשתתפים. בדיונים מוקדמים, תוכלו להכין הצעה טובה לפרויקט.
ההצעה שלכם לפרויקט בטופס הבקשה:
שם הארגון בקוד פתוח: מזינים את השם של ארגון הקוד הפתוח שאיתו רוצים לעבוד במהלך העונה של Docs. השם צריך להיות אחד מהארגונים המשתתפים, שמוצגים באתר של עונה של Docs.
שם פרויקט בקוד פתוח: זהו השם של פרויקט הקוד הפתוח שרוצים לעבוד עליו בעונה של Docs. הפרויקט חייב להשתייך לאחד מהארגונים המשתתפים, שמוצגים באתר העונה של Docs. בחלק מהארגונים, שם הארגון ושם הפרויקט עשויים להיות זהים.
השם של פרויקט הכתיבה הטכנית שאתם מציעים. יש להוסיף שם קצר ותיאורי שמסכם את המטרה העיקרית של העבודה שאתם מציעים.
תיאור מפורט. כדאי לציין כמה שיותר פרטים בתיאור של פרויקט הכתיבה הטכנית שאתם מציעים. אפשר להזין מספר פסקאות בשדה התיאור. ריכזנו כאן כמה רעיונות לתוכן שאפשר לכלול:
- יש לספק פרטים על המסמכים שברצונך ליצור/לעדכן. אם אתם מתכננים לעדכן מסמך או אתר קיים, הוסיפו קישור ותיאור של העדכונים המוצעים. אם אתם מציעים מסמך חדש או אתר חדש, עליכם לתאר את התוכן ואת הקהל.
- למה אתם מציעים את המסמכים או העדכונים החדשים?
- אם דנתם בפרויקט עם מישהו מארגון הקוד הפתוח, עליכם לכלול סיכום של התוצאות של הדיונים האלה.
- חשוב לשים לב לשפה ולסגנון של ההצעה. הארגון של הקוד הפתוח עשוי להשתמש בנתונים האלה כגורם להערכת ההצעה.
- אל תכללו קישור לתיאור הפרויקט. בתיאור צריך לכלול את כל הפרטים הקובעים של הפרויקט שלכם. לארגון הקוד הפתוח צריכה להיות אפשרות לבחור את התוכן על סמך התוכן בטופס הבקשה ולא על סמך תוכן שנשמר במקום אחר. אם אתם צריכים לקשר לתוכן אחר שמשלים את התיאור, זה בסדר, אבל חשוב לזכור שרק התוכן של טופס הבקשה משמש לבחירת הפרויקטים.
שדות חשובים נוספים בטופס הבקשה
בטופס הבקשה מפורטות ההנחיות לגבי פרטים חשובים נוספים:
בחירת פרויקט באורך רגיל או ארוך: התקופה הסטנדרטית לשלב פיתוח המסמך בעונה של Docs היא שלושה חודשים. אם נדרש פרק זמן ארוך יותר לפרויקט, עליכם לציין זאת בטופס הבקשה לאחר התייעצות עם ארגון הקוד הפתוח שבחרתם. אפשר לעיין בתיאור של פרויקטים ארוכים.
קבלת מלגת Docs זמינה בעונה: משלמים סכום כספי לכותבים הטכניים שהשלימו את הפרויקטים שלהם בהצלחה, בתנאי שהכותבים הטכניים רוצים לקבל את המלגה. למידע נוסף על מלגות לכותבים טכניים. גובה התשלום הוא אופציונלי. אם אתם לא רוצים לקבל את המענק, ציינו את הבחירה בטופס הבקשה.
כיצד 'עונת המסמכים' משתמשת במידע מטופס הבקשה שלך
הקטע הזה מסכם את האופן שבו 'עונה של Google' משתמשת במידע מטופס הבקשה. בקטעים קודמים של הדף מתוארים שדות המפתח בפירוט.
בטבלה מפורטים שדות המפתח. בכל שדה, הטבלה מציינת אם העונה של Docs:
- מעביר את המידע לארגון הקוד הפתוח שציינתם בטופס הבקשה.
- פרסום של רשימת הפרויקטים הקבילים לכתיבה טכנית באתר של Docs ב-עונה.
| מידע בטופס | שיתפת עם ארגון קוד פתוח? | מוצג באתר העונה של Docs? |
|---|---|---|
| השם המלא | ||
| השם המוצג | ||
| כתובת האימייל | ||
| ניסיון בכתיבה טכנית מהזמן האחרון | ||
| קישור לחידוש או קורות חיים | ||
| קישור לדוגמאות לעבודה | ||
| כל דבר נוסף שברצונך להוסיף | ||
| שם הארגון/הפרויקט בקוד פתוח | ||
| השם והתיאור של פרויקט הכתיבה הטכנית | ||
| פרויקט ארוך או באורך רגיל | ||
| אישור התשלום לקרן |
מפתח לסמלים המשמשים בטבלה שלמעלה:
| סמל | משמעות הסמל |
|---|---|
| כן | |
| לא |
הערות
הנה עוד כמה נקודות שכדאי לזכור:
הגשת הצעות לפרויקטים מרובים: ניתן להגיש יותר מהצעה אחת לפרויקט, אבל ב-עונת המסמכים של Docs אפשר לקבל רק הצעה אחת לפרויקט לכל כותב טכני. ניתן לשלוח טופס בקשה אחד בלבד. הטופס מאפשר עד שלוש הצעות לפרויקט.
המספר הכולל של פרויקטים של כתיבה טכנית בתוכנית: בעונה של Docs אפשר לקבל רק מספר מקסימלי מסוים של פרויקטים טכניים של כתיבה. איך עובדת הקצאת יחידות קיבולת (Slot)
מדריכים קשורים
קראו את הרמזים למנטורים שיעזרו לכם להעריך הצעות של כותבים טכניים. אם תבינו את הקריטריונים לבחירת המנטורים, תוכלו לגבש הצעה עם סיכוי גבוה יותר להצליח.
לקבלת מידע על המועד ואופן ההגשה של בקשת הרשמה ל-Docs ב-Docs, קראו את המדריך הטכני לכתיבה.