רעיונות לפרויקטים

השלב הנוכחי:
תוכנית 'עונת 2020 של Docs' הסתיימה ב-15 במרץ 2021. אפשר לראות את ציר הזמן.

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

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

פרויקטים לדוגמה

פירטנו כאן כמה רעיונות לסוגי פרויקטים שכותבים טכניים יכולים לטפל בהם:

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

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

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

  • ליצור מדריך לתרחיש לדוגמה בעל פרופיל גבוה.

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

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

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

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

מפרסמים את רשימת הרעיונות לפרויקטים

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

דף הרעיונות לפרויקט צריך לכלול:

  • מידע על ארגון הקוד הפתוח שלכם:

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

  • הודעה על כך שהארגון שלכם מבקש להשתתף בעונה החדשה של Docs. בדף קידום מכירות ועיתונות תוכלו למצוא סמלי לוגו ותוכן נוסף שתוכלו להשתמש בו כדי לדבר על העונה של Docs.

  • הרעיונות שלך לפרויקט, כולל המידע שמתואר בהמשך, לכל רעיון לפרויקט.

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

המידע בכל רעיון לפרויקט

כל רעיון לפרויקט חייב לכלול לפחות את המידע הבא:

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

  • חומר קשור:

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

החשיבות של הרעיונות לפרויקטים

הרעיונות לפרויקטים חשובים בכמה דרכים:

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