מדריך כתיבה טכני

זהירות: המסמך הזה מתייחס לעונה של תוכנית Docs ל-2020. מסמכי התיעוד הנוכחיים של התוכנית.

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

בדף זה תמצאו מדריך לכותבים טכניים שמשתתפים בתוכנית Docs.

מבוא

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

לתשומת לבכם: חשוב לקרוא בעיון את דף התחומי האחריות שלכם, ולקחו בחשבון את תחומי האחריות האלה לאורך התוכנית של העונה של Docs.

זכאות להשתתף בעונה של Docs

כדי להשתתף בעונה של Docs ככותבים טכניים, עליכם:

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

לעיון בתנאים המלאים לכותבים טכניים.

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

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

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

שלבי הבקשה לשליחת הודעות לגבי התוכנית והגשת בקשות לארגון

תאריך ההכרזה על עונה של Docs הוא 23 במרץ 2020. ארגונים שמעוניינים בקוד פתוח יכולים להגיש בקשה להשתתפות בעונה של Docs בין 13 באפריל 2020 ל-4 במאי 2020. מנהלי התוכנית של Google יפרסמו את רשימת הארגונים שהצליחו ב-11 במאי 2020.

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

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

שלב הניתוח של הכותב הטכני

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

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

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

שלב הגשת הבקשה לכתיבה טכנית

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

המשימות שלך ככותב/ת מגיש/ה טכני/ת במהלך השלב הזה
שלח את בקשתך כדי להשתתף בעונה של Docs.	עליך לשלוח את בקשת ההצטרפות לעונה של Docs לפני 9 ביולי 2020. יצירת האפליקציה עונת 2020 של ההרשמה לכתיבה טכנית ב-Docs סגורה עכשיו. כדאי להצטרף לרשימת התפוצה של ההודעה בכתובת season-of-docs-announce באימייל.

שלב גיבוש הקהילה

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

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

שלב הפיתוח של המסמך

שלב הפיתוח של המסמך נמשך מ-14 בספטמבר 2020 עד 30 בנובמבר 2020. (בפרויקטים ארוכים, תאריך הסיום שונה.) במהלך התקופה הזו, אתם עובדים על הפרויקט תוך התייעצות צמודה עם המנטורים שלכם.

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

השלב הסופי וההערכה של הפרויקט

שלב הבנייה של הפרויקט נמשך מ-30 בנובמבר עד 5 בדצמבר 2020, ושלב ההערכה פועל בין 3 ל-10 בדצמבר 2020. (התאריכים של פרויקטים לטווח ארוך שונים מהתאריכים). במהלך התקופה הסופית של הפרויקט, אתם שולחים את דוח הפרויקט, שנקרא גם 'תוצרים של העבודה הסופית'. בשלב ההערכה, אתם שולחים הערכה של המנטורים שלכם ושל החוויה שלכם כמשתתפים בעונת Docs.

המשימות שלך ככותבים טכניים בשלב הזה
כותבים את דוח הפרויקט.	כותבים את דוח הפרויקט (נקרא לפעמים מוצר העבודה). דוח הפרויקט כולל תיאור של העבודה שעשית במהלך העונה של Docs, וכל קישור רלוונטי. יצירת דוח פרויקט שלב השלמת הפרויקט הממושך הסתיים.
בקשו מהמנטור לבדוק את דוח הפרויקט.	יכול להיות שלמנטור יש תובנות חשובות איך לתאר את ההישגים שלכם. בנוסף, כדאי להגיע להבנה משותפת של מצב הפרויקט בשלב הזה, לפני שהחונך מסמן שהפרויקט הושלם בהצלחה או לא.
מסיימים את דוח הפרויקט.	צריך לסיים את דוח הפרויקט עד 8 במרץ 2021 בשעה 18:00 UTC. אפשר לערוך את הטופס, אבל צריך לשלוח את הגרסה הסופית שלו עד התאריך הנתון. שלב השלמת הפרויקט הממושך הסתיים.
יש לך אפשרות לכתוב ולשלוח את ההערכה למנטור שלך ולחוויית תקופת הניסיון של Docs ב-Docs.	עליך להשלים את ההערכה ולשלוח אותה עד 12 במרץ 2021 בשעה 18:00 UTC. הערכות של כותבים טכניים האחריות שלך השלב הממושך של הערכת הפרויקט הסתיים.

פרויקטים ותיקים

בפרויקטים של כתיבה טכנית באורך רגיל ב-עונת המסמכים של Docs, שלב פיתוח המסמכים פועל מ-14 בספטמבר 2020 עד 30 בנובמבר 2020. עם זאת, חלק מהכותבים הטכניים עשויים להגיש בקשה לפרויקט קיים, בהתייעצות עם ארגון הקוד הפתוח. בפרויקט ותיק, שלב הפיתוח של המסמך פועל מ-14 בספטמבר 2020 עד 1 במרץ 2021.

התקופה הסופית וההערכה של פרויקטים קיימים היא בין 1 ל-8 במרץ 2021.

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

מידע קשור

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