שאלות נפוצות

השלב הנוכחי:
סיום הפרויקט. ציר הזמן

כללי

האם Google Season of Docs היא תוכנית גיוס?

לא. אם אתם מעוניינים לעבוד ב-Google, תוכלו להיכנס לאתר של Google למציאת עבודה.

מה ההבדל בין התוכנית הנוכחית לבין 'עונת התיעוד של Google' בשנים 2019 ו-2020?

בתוכנית הנוכחית של Google Season of Docs יש שינויים משמעותיים בהשוואה לשנים קודמות, כולל:

  • עכשיו, סופרים טכניים לא צריכים יותר לשלוח בקשה דרך Google כדי להתאים לארגונים
  • הארגונים שולחים הצעות לפרויקטים כחלק מהבקשה, כולל תקציב ומדדים מוצעים
  • ארגונים שעומדים בדרישות מקבלים מענקים, שבאמצעותם הם משלמים לכותבים טכניים.
  • הארגונים שולחים הערכות סופיות ומקרים לדוגמה

למה בוצעו השינויים האלה ב-Google Season of Docs?

המטרה של Google היא לארגן את המידע בעולם ולהפוך אותו לנגיש ומועיל לכולם. אנחנו מקווים שהשינוי במטרה של Google Season of Docs, שמתמקדת עכשיו בלמידה של שיטות יעילות לתיעוד בקוד פתוח, יעזור לנו להשפיע בצורה משמעותית יותר בטווח הארוך.

הארגון שלנו רוצה להשתתף ב-Google Season of Docs, אבל אנחנו לא יודעים מאיפה להתחיל.

כאן תוכלו למצוא את הרשימה המלאה של רעיונות לפרויקטים. אתם יכולים גם לפנות לקהילה של כתיבה טכנית (כדאי לנסות את הערוץ #season-of-docs ב-Write the Docs Slack או בערוצי הרשתות החברתיות שלכם כדי לבקש עזרה או הצעות).

אילו סוגי פרויקטים ארגונים יכולים להציע?

רעיונות לשינויים:

  • יוצרים אתר מסמכי עזרה בפלטפורמה שתיקבע על ידי הכותבים הטכניים והארגון של קוד המקור הפתוח, ומפרסמים באתר קבוצה ראשונית של מסמכים בסיסיים. דוגמאות לפלטפורמות:

  • שיפור של המסמכים הקיימים של פרויקט הקוד הפתוח כדי לספק חוויית משתמש משופרת או ארכיטקטורת מידע נגישה יותר.

  • כתיבת סקירה כללית מושגית או מבוא למוצר או לתכונה. לרוב, צוותים יוצרים את המסמכים הטכניים שלהם מלמטה למעלה, וכתוצאה מכך יש בהם הרבה פרטים אבל קשה להבין את המוצר כמכלול. כותב טכני יכול לפתור את הבעיה הזו.

  • יצירת הדרכה לתרחיש שימוש חשוב.

  • ליצור קבוצה של מדריכים ממוקדים למשימות ספציפיות.

  • יוצרים מדריך למשתתפים שכוללים מידע בסיסי על תחילת העבודה כמשתתפים בפרויקט בקוד פתוח, וכן כללים לגבי הסכמי רישיון, תהליכים לבקשות משיכה ולבדיקות, פיתוח הפרויקט וכו'.

האם סרטון יכול להיחשב כפרויקט ב-Google Season of Docs?

כן. חשוב לוודא שהדרישות לסרטון מתאימות לפרויקט, ולהביא בחשבון שתהליך הפקת סרטון באיכות גבוהה דורש זמן ומשאבים רבים.

האם ביקורת של מסמכי תיעוד היא פרויקט מתאים ל-Google Season of Docs?

בדיקת מסמכי העזרה היא פרויקט מצוין ל'עונת המסמכים של Google'. חשוב לזכור כמה מסמכים כבר יש לכם. אם יש לכם הרבה, יכול להיות שתצטרכו לצמצם את ההיקף (לדוגמה, רק לבצע ביקורת על תוכן של מדריכים). אם יש לכם מעט מסמכי עזרה או שאין לכם בכלל, כדאי לכלול בפרויקט את היצירה של מסמכי העזרה החסרים בעדיפות הגבוהה ביותר.

האם יש תבניות מסמכים שזמינות לארגונים ולכותבים טכניים?

ל-Google Season of Docs יש מאגר ב-GitHub עם תבנית ורשימת משימות לביצוע ביקורות של מסמכי עזרה. אנחנו מקווים להוסיף תבניות נוספות ככל שנוצרות.

פרויקט Good Docs פועל ליצירת תבניות מינימליסטיות לתיעוד בקוד פתוח.

האם ארגונים נדרשים להשתמש במסמכים שנוצרו על ידי סופרים טכניים?

לא. לפעמים פרויקטים לא מתבצעים כמצופה או שהדרישות משתנות. אנחנו לא דורשים מהארגונים להשתמש במסמכים או בחומרים אחרים שנוצרו, אבל אנחנו כן מצפים שההערכה הסופית ודוח המחקר יכילו דיון לגבי הסיבה לכך שלא נעשה שימוש במסמכים, ואיך הוחלט בפרויקט לא להשתמש במסמכים או בחומרים אחרים.

איפה מתקיים Google Season of Docs?

אירוע Google Season of Docs מתקיים כולו באינטרנט. אין דרישה לנסוע במסגרת התוכנית.

איך אפשר להתעדכן בחדשות על Google Season of Docs?

כדי לקבל את העדכונים וההודעות האחרונים לגבי Google Season of Docs, אפשר להירשם לרשימת התפוצה season-of-docs-announce. הצטרפו לקבוצה כדי לקבל עדכונים באימייל.

האם אפשר להוסיף את ציר הזמן של Google Season of Docs ליומן?

כן, אפשר להוסיף אותו דרך הקישור הזה.

מה אפשר לעשות כדי לעזור להפיץ את החדשות על 'עונת המסמכים של Google'?

אתם יכולים לפרסם ציוצים על התוכנית, לכתוב פוסטים בבלוג, לפרסם סרטונים או לארח אירוע Meetup או סשן מידע באזור שלכם. יש לנו כמה מקורות מידע ותוכן לדוגמה שאפשר להפיץ לקהילה שלכם (ארגון, קבוצת סופרים וגורמים נוספים ליצירת קשר).

איך מארגנים או מארחים סשן מידע או מפגש של Google Season of Docs?

אפשר לקבוע פגישה בכל זמן ובכל מקום שנוח לך. יש לעיין בכללים של התוכנית ולהשתמש בתוכן לדוגמה.

יש לך נתונים סטטיסטיים שאפשר לשתף לגבי עונות Docs בשנים 2019 ו-2020?

כן, אפשר לראות את התוצאות של Google Season of Docs בתוכנית של 2019 כאן, ואת התוצאות של התוכנית של 2020 כאן.

האם אקבל חולצה של Google Season of Docs?

לא, עקב מגבלות על משלוח בינלאומי, לא נוכל יותר לספק חולצות למשתתפים שישלימו בהצלחה את הפרויקט שלהם במסגרת Google Season of Docs.

למי אפשר לפנות אם יש עוד שאלות?

מומלץ לעיין במדריך לאדמינים ארגוניים ובמדריך לכותבי טכנולוגיה.

אם אחרי קריאת כל המסמכים עדיין אין לכם תשובה, תוכלו לשאול את השאלות שלכם בקהילה של Google Season of Docs ברשימת הדיונים. כדאי לעיין במידע על ערוצי דיון ועל דרכי יצירת קשר איתנו.

איך אפשר להיות מנטור בתוכנית Google Season of Docs?

אין תפקיד רשמי של מנטור בתוכנית Google Season of Docs. הארגונים צריכים לציין איך יתבצע תהליך ההצטרפות של הכותבים הטכניים ואיך יתבצע התהליך של בדיקה ואישור של התכנים שהם כותבים, כחלק מהבקשה של הארגון. אם אתם רוצים להדריך סופרים טכניים במסגרת Google Season of Docs, מומלץ לפנות לאדמינים של הארגון שלכם כדי להתנדב.

האם Google Season of Docs דומה ל-Google Summer of Code?

לא. Google Season of Docs מיועד לאנשים עם ניסיון מסוים בכתיבה טכנית, והוא לא תוכנן כתוכנית הדרכה כמו Google Summer of Code.

לכותבים טכניים

מתי סופרים טכניים יכולים להגיש בקשה להשתתפות בתוכנית Google Season of Docs?

אין בקשת הצטרפות רשמית לתוכנית Google Season of Docs של כותבי טקסט טכני. כדי להשתתף בתוכנית Google Season of Docs ככותבים טכניים, צריך לפנות ישירות לארגונים של קוד פתוח לפי ההוראות שבדף התוכנית שלהם ב-Google Season of Docs. אפשר גם להביע עניין על ידי הוספה למאגר של Google Season of Docs של סופרים טכניים. מידע נוסף זמין במדריך לכותבי טכניקה.

אילו כלים ותבניות לתיעוד כדאי להכיר כדי להשתתף ב-Google Season of Docs?

הכלים והמסגרות לתיעוד שבהם תשתמשו תלויים בארגון שבו אתם רוצים לעבוד. חלק מהמטרה של Google Season of Docs היא לאפשר לכותבים טכניים ללמוד יותר על הכלים והמסגרות שקשורים לתיעוד מוצרים בקוד פתוח, באמצעות הפרויקטים בקוד פתוח. לכן, בדרך כלל אין צורך בידע מפורט בפלטפורמות ספציפיות של מסמכי עזרה לפני שמתחילים בפרויקט של Google Season of Docs.

עם זאת, רוב הארגונים של קוד פתוח משתמשים בגרסה כלשהי של Markdown או בשפת סימון אחרת למסמכים שלהם. מומלץ לברר באיזו שפה הארגון שבחרתם משתמש ולהכיר את התחביר. Markdown הוא התחלה טובה, כי קובצי README ב-GitHub מבוססים על Markdown. כאן תוכלו לקרוא את המדריך של GitHub ל-Markdown.

כדאי לבדוק אם הארגון שבחרתם כבר מארח את המסמכים שלו באתר, ואם כן, באיזו פלטפורמה הוא משתמש. הפלטפורמה יכולה להיות תוכנה ליצירת אתרים סטטיים כמו Jekyll,‏ Sphinx או Hugo, או שהארגון יכול לארח את המסמכים שלו ב-Read the Docs או ב-GitHub Pages. אחרי שתבררו באיזו פלטפורמה הארגון משתמש, תוכלו לבדוק ולנסות את השפה והמסגרת הרלוונטיות. כך תוכלו להתחיל לעבוד במהירות על הפרויקט שלכם בקוד פתוח, ותוכלו לספק עצות טובות לפרויקט הקוד הפתוח שבחרתם.

אילו שפות תכנות צריך לדעת כדי להשתתף בפרויקטים של Google Season of Docs?

בהתאם לאופי פרויקט התיעוד, יכול להיות שתצטרכו להכיר שפת תכנות. חשוב לזכור את זה כשאתם בוחרים ומציעים פרויקט תיעוד, ולברר עם הארגון של קוד המקור מהי רמת ההיכרות הנדרשת.

האם סופרים טכניים שכבר עובדים על פרויקט בקוד פתוח יכולים להמשיך לעבוד עליו כחלק מ-Google Season of Docs?

כן, אבל הארגון צריך לציין בבקשה את הקשר הקודם או הנוכחי של הסופר הטכני לפרויקט.

מהן דרישות הסף להשתתפות?

האם צריך ניסיון קודם או הכשרה ככותב טכני?

ניסיון קודם בכתיבה טכנית או הכשרה בתחום יתקבלו בברכה, אבל הם לא חובה. כששולחים הצהרת עניין לארגון, אפשר לתאר את הניסיון ו/או ההכשרה שלכם בכתיבה טכנית. עליכם לספק הוכחה כלשהי שמראה את העניין שלכם במסמכים טכניים או במסמכים בקוד פתוח, כולל דוגמאות למסמכים שכתבתם. הארגון בקוד פתוח יחפש סופרים טכניים עם רמת הניסיון הנדרשת כדי להבטיח השלמה מוצלחת של הפרויקטים שלהם במסגרת Google Season of Docs.

האם אקבל תשלום על ההשתתפות ב-Google Season of Docs?

כן. Google תעניק מענקים לארגונים שאושרו, לצורך העסקת סופרים טכניים.

איך נראית הצהרת עניין טובה של כותב טכני?

הצהרות העניין הטובות ביותר מגיעות מסופרים טכניים שמוצאים זמן לנהל אינטראקציה עם הארגון לקוד פתוח שבחרתם ולדון איתו ברעיונות שלהם לפני שליחת ההצהרות. איך יוצרים הצהרת עניין

כמה זמן נמשכת ההשתתפות ב-Google Season of Docs?

גודל הפרויקטים משתנה, אבל ההתחייבות היא ל-5 עד 30 שעות בשבוע במהלך התוכנית. עם זאת, משך הזמן תלוי באופי הפרויקט שסיכמתם עליו עם הארגון. לפני שמתחייבים, כדאי להעריך את הפרויקט ולדון עם הארגון של קוד המקור על זמן משוער.

האם אפשר להגיש בקשה מטעם ארגון כדי ליצור מסמכי תיעוד לפרויקט בקוד פתוח כאדם פרטי? אני רוצה ליצור סדרה של פוסטים בבלוג, סרטונים או חומרים אחרים בנושא שימוש בכלי או בפרויקט בקוד פתוח, אבל אני לא חלק מהפרויקט או תורם לפרויקט.

לא, צריך לשלוח הצעה רק אם יש לכם אפשרות לקבל כספים בשם הפרויקט בקוד פתוח. מומלץ לפנות לפרויקט ולשתף פעולה על הצעת בקשה.

אני תלמיד/ה. האם אוכל להשתתף ב-Google Season of Docs? האם תוכנית Google Season of Docs תעזור לי להפוך לכותב טכני?

התלמידים יכולים לעבוד עם ארגונים שאושרו, אבל Google Season of Docs לא מיועד ללמד כישורי כתיבה טכנית. אנחנו מצפים שכותבי הטכני שישתתפו בתוכנית יהיו בעלי כישורי כתיבה טכנית מקצועיים או ניסיון רלוונטי שווה ערך. תלמידים שרוצים להשתתף צריכים להדגיש את הניסיון הרלוונטי שלהם בכתיבת תוכן ובעריכה כשהם פונים לארגונים ולפרויקטים שעשויים להתעניין בכך.

האם אפשר להשתתף ככותבים טכניים ב-Google Season of Docs וכתלמידים ב-Google Summer of Code?

למרות שזה לא אסור כרגע, אנחנו ממליצים בחום שסטודנטים שהתקבלו ל-Google Summer of Code לא יגישו בקשה לתוכנית Google Season of Docs ככותבים טכניים. התלמידים צריכים להתמקד בעבודה ב-Google Summer of Code במקום להגיש בקשה ל-Google Season of Docs.

בנוסף, 'עונת המסמכים של Google' לא מיועדת למתחילים, אלא לאנשים שכבר יש להם ניסיון וכישורים טובים עד מעולים בכתיבה טכנית. בתוכנית Google Season of Docs, הכותבים הטכניים לא מקבלים הדרכה. במקום זאת, הם צריכים להיות מסודרים וממושמעים ולתכנן בעצמם איך לטפל בפרויקט של הארגון, עם הדרכה מינימלית מהאדמינים של הארגון ומחברים אחרים בקהילה.

ככותבים טכניים, איך אפשר ליצור קשר עם האדמינים של תוכנית Google Season of Docs ב-Google אם יש לכם שאלות או בעיות נוספות?

אפשר ליצור קשר עם האדמינים של תוכנית Google Season of Docs ב-Google באמצעות אימייל לכתובת season-of-docs@google.com.

האם חברות ייעוץ או חברות כתיבה טכנית יכולות להשתתף בתוכנית Google Season of Docs?

כן, ארגון יכול להעסיק חברה כדי לבצע את העבודה שמפורטת בהצעה שלה.

איך אפשר לציין את Google Season of Docs בקורות החיים?

מציינים את הפרטים כמו בכל עבודה אחרת כשכיר עצמאי, למשל: "עבדתי ככותב טכני בפרויקט [שם הפרויקט] כחלק מתוכנית Google Season of Docs".

האם אתם מספקים אישורי השלמה על השתתפות ב-Google Season of Docs?

אין לנו אפשרות לשלוח אישורים או אישורי השתתפות בפרויקט לכותבים טכניים.

לאדמינים של ארגונים בקוד פתוח

מהן דרישות הסף לארגון בקוד פתוח?

כדי להשתתף כקבוצה, אתם צריכים להיות קבוצה שמפעילה פרויקט תוכנה פעיל בקוד פתוח או בקוד חופשי, כמו BRL-CAD. הפרויקט לא צריך להיות ישות משפטית רשומה. כדי להשתתף בתוכנית, הארגונים צריכים כבר ליצור ולפרסם תוכנה במסגרת רישיון שאושר על ידי Open Source Initiative, ולכלול לפחות שני שותפים שיפעלו כאדמינים של הארגון במשך כל תקופת התוכנית של Google Season of Docs.

מומלץ לעיין גם בדרישות הסף שמפורטות בכללים של התוכנית ובתוכניות הסנקציות ומידע על מדינות של משרד האוצר האמריקאי.

האם 'ארגון' שווה ערך לפרויקט בקוד פתוח?

לארגון יכול להיות פרויקט אחד או יותר בקוד פתוח. לארגונים מסוימים, כמו קרנות, יכולים להיות כמה ארגונים משניים, לכל אחד מהם פרויקט אחד או יותר בקוד פתוח. אם לארגון שלך יש ארגונים משניים עצמאיים, עליך לשלוח בקשות והצעות נפרדות לכל ארגון משני.

האם ארגון יכול לשלוח יותר מבקשה אחת להצעה?

לא. יש להגיש בקשה אחת בלבד לכל ארגון. אם לארגון שלכם יש ארגונים משניים (לדוגמה, הארגון הוא קרן עם הרבה פרויקטים נפרדים בקוד פתוח), כל פרויקט צריך לשלוח בקשה משלו, גם אם ארגון הגג יטפל בכספי המענק.

האם קבוצה של פרויקטים בקוד פתוח יכולה לשלוח הצעה ביחד כדי לעבוד על פרויקט תיעוד אחד?

ארגון אחד צריך לשלוח את הבקשה להצעה ולהיות אחראי על תיאום העבודה והתמיכה מפרויקטים אחרים שמשתתפים. (לדוגמה, קבוצה של פרויקטים קטנים בקוד פתוח, כולם יוצרים של יישומי פלאגין לפרויקט גדול יותר, שרוצים לעבוד על מדריך משותף ליצירת יישומי פלאגין, צריכה לבחור ארגון אחד שינהל את הפרויקט).

איך הארגון שלי יקבל את התרומות?

כדי לקבל כספים, לארגון שלכם צריך להיות חשבון ב-Open Collective.

האם הארגונים מקבלים כסף על ההשתתפות ב-Google Season of Docs?

ארגונים יכולים לכלול תקציבים לניהול, להדרכה או לבדיקת עבודות כחלק מתקציבי הפרויקטים שלהם.

האם Google משלמת את העמלות על עיבוד התשלומים?

Google לא משלמת את העמלות על עיבוד התשלומים, כי הן משתנות בהתאם לאמצעי התשלום. עם זאת, Google כן מכסה את העמלה של פלטפורמת Open Collective, ואם תחליטו להשתמש ב-Open Collective כמארחת הפיננסית, העמלה הזו תהיה מכוסה גם כן. מידע נוסף זמין במדריך לקבלת מענקים.

איך הארגון שלי צריך לתקצב את העלות של כותב טכני?

מומלץ לעיין בסקר השכר של Write the Docs ולחשב את התעריפים לשעה. אפשר גם להצטרף ל-Write The Docs Slack ולבקש בערוץ #season-of-docs שכותבים טכניים מעוניינים יציעו הצעות מחיר.

האם הארגון שלי יכול להשתמש במענק של Google Season of Docs כדי לשלם לתורם קיים?

כן. עם זאת, הצעות לפרויקטים חייבות להיות לעבודה חדשה (כולל עבודות תחזוקה, גרסאות מתוקנות או שדרוגים של מסמכים קיימים). אסור להגיש בקשה למענק כדי לשלם על עבודה שכבר הושלמה.

האם הארגון שלי יכול לעבוד עם תלמידים שמתמחים בכתיבה טכנית?

אתם יכולים לבחור לעבוד עם תלמידים שמתמחים בכתיבה טכנית בפרויקט שלכם. אם בחרתם לעבוד עם תלמידים, מומלץ מאוד להגביל את ההשתתפות לתלמידים שעומדים בדרישות הבאות:

  • בני 18 ומעלה
  • רשומים לתוכנית או לקורס בנושא כתיבה טכנית או תקשורת טכנית
  • יש להם גישה מוכחת למנטורות בכתיבה טכנית דרך התוכנית או הקורס שלהם

האם הארגון שלי יכול לעבוד עם יותר מסופר טכני אחד?

הארגון שלכם יכול לבחור ולשלם יותר מסופר טכני אחד, אבל כל הסופרים הטכניים שעובדים עם הארגון שלכם חייבים לעבוד על הפרויקט שהצעתם. עבודה עם כמה סופרים טכניים תוסיף מורכבות לפרויקט ותדרוש יותר זמן של מתנדבים ואדמינים.

האם הארגון שלי יכול להעסיק חברת כתיבה טכנית לעבודה על הפרויקט שלנו?

כן, הארגון שלכם יכול להעסיק חברה לכתיבה טכנית שתעבוד על הפרויקט. חשוב לוודא שאפשר לשלם לחברה שאתם שוכרים דרכם דרך Open Collective.

הסופר הטכני שלנו עזב לפני סיום התוכנית. האם עדיין יש לנו זכאות לקבל את יתרת הסכום?

מומלץ מאוד לנסות למצוא סופר טכני חדש שיסיים את הפרויקט לפני סיום התוכנית. עם זאת, תשלום יתרת הסכום לא יתבצע על סמך השלמת הפרויקט, אלא על סמך השלמת המחקר וההערכה הסופית.

אם לא הצלחת להשלים את הפרויקט, אנחנו מצפים שבדוח המחקר תבדוק למה. לדוגמה, יכול להיות שגיליתם שהכלים ליצירת מסמכי תיעוד מורכבים מאוד ומהווים מכשול להוספת סופר טכני לצוות, או שהפרויקט כלל בדיקה ועדכון של מדריכים ודרוש בו ניסיון נרחב בקוד. מה המלצותיך לפרויקטים אחרים, על סמך הניסיון שלך? מומלץ לכלול את המידע הזה בניתוח המקרה.

האם אפשר לבדוק בקשה של ארגון לפני מועד ההגשה?

לצערנו, אנחנו לא יכולים לספק משוב על הבקשה של הארגון.

איך ארגונים צריכים להגדיר את היקף ההצעות לפרויקטים?

כשמפתחים רעיונות לפרויקטים, כדאי לנסות למצוא פרויקטים קטנים ככל האפשר שיצרו ערך לארגון (אבל אפשר להרחיב אותם אם יש זמן). עדיף קטן יותר. כשיוצרים את הצעת הפרויקט, מומלץ להתמקד בפרויקטים קטנים ומפורטים יותר, ולא בפרויקטים גדולים פחות מפורטים. אם הפרויקט דורש מומחיות רבה בתחום, נסו לכלול פרויקטים שאפשר לעבוד עליהם גם בלי הרקע הזה.

האם אדמינים ארגוניים יכולים להשתתף ב-Google Season of Docs בתור מנחים ב-Google Summer of Code?

כן. Google Season of Docs ו-Google Summer of Code הן תוכניות נפרדות. אם יש לכם את רוחב הפס הנדרש כדי להשתתף בשתי התוכניות, זה בסדר.

הארגון שלנו השתתף בתוכניות קודמות של Google Season of Docs. האם יש לנו אפשרות להגיש שוב בקשה?

כן, ארגונים שהשתתפו בתוכניות קודמות של Google Season of Docs יכולים להגיש בקשה שוב.

נתונים שהועברו לארכיון

איך מסירים את הפרטים מהארכיון של Google Season of Docs?

צרו איתנו קשר כדי להסיר את המידע שלכם.