בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.
סיכום הפרויקט
- ארגון בקוד פתוח:
- OpenJS Foundation
- כותבים טכניים:
- בהיר
- שם הפרויקט:
- שדרוג מקיף של מסמכי התיעוד של Fastify
- אורך הפרויקט:
- אורך רגיל (3 חודשים)
תיאור הפרויקט
אתמקד בשני תחומים. אחת השיטות האלה היא ליצור מדריך סגנון, שכולל גם שינוי מבנה של המסמכים הקיימים ב-fastify.io, כדי שיהיה למשתמשים חדשים קל לעקוב אחרי התהליך בצורה חלקה. השני יהיה שיפור האיכות של התוכן שתורמים מוסיפים ל-fastify, כדי שתורמים חדשים ייתקלו בפחות בלבול וספקות לאורך הדרך. במצב אידיאלי, התוצאה תהיה דרך ברורה ותמציתית מהתרומה הראשונה ועד להיכרות עם אופן הפעולה של Fastify.
הפרויקט הזה יעבור את 4 השלבים הבאים. בשלב הראשון, נלמד על הכלים המקיפים הזמינים ונבין טוב יותר את הצרכים הנוכחיים שלכם בנושא תיעוד. המטרה של השלב השני היא לבנות את ההקשר של יעדי Fastify ב-GSoD הזה, לציין אותם ולתת להם עדיפות. לאחר מכן נתחיל את שלב ההטמעה, שכולל תנועה הלוך ושוב עם המנטורים ועם קהילת המפתחים של Fastify לקבלת משוב. בשלב האחרון יש לבדוק ולתקן לפי הצורך ולכתוב את דוח הפרויקט.
אעשה כמיטב יכולתי כדי לתרום להצלחה הכוללת של הפרויקט הזה בקוד פתוח.