פרויקט יסודות של OpenJS
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.
סיכום הפרויקט
- ארגון בקוד פתוח:
- OpenJS Foundation
- כותבים טכניים:
- בהיר
- שם הפרויקט:
- שדרוג מקיף של מסמכי התיעוד של Fastify
- אורך הפרויקט:
- אורך רגיל (3 חודשים)
תיאור הפרויקט
אתמקד בשני תחומים. אחת השיטות האלה היא ליצור מדריך סגנון, שכולל גם שינוי מבנה של המסמכים הקיימים ב-fastify.io, כדי שיהיה למשתמשים חדשים קל לעקוב אחרי התהליך בצורה חלקה. השני יהיה שיפור האיכות של התוכן שתורמים מוסיפים ל-fastify, כדי שתורמים חדשים ייתקלו בפחות בלבול וספקות לאורך הדרך. במצב אידיאלי, התוצאה תהיה דרך ברורה ותמציתית מהתרומה הראשונה ועד להיכרות עם אופן הפעולה של Fastify.
הפרויקט הזה יעבור את 4 השלבים הבאים.
בשלב הראשון, נלמד על הכלים המקיפים הזמינים ונבין טוב יותר את הצרכים הנוכחיים שלכם בנושא תיעוד.
המטרה של השלב השני היא לבנות את ההקשר של יעדי Fastify ב-GSoD הזה, לציין אותם ולתת להם עדיפות. לאחר מכן נתחיל את שלב ההטמעה, שכולל תנועה הלוך ושוב עם המנטורים ועם קהילת המפתחים של Fastify לקבלת משוב.
בשלב האחרון יש לבדוק ולתקן לפי הצורך ולכתוב את דוח הפרויקט.
אעשה כמיטב יכולתי כדי לתרום להצלחה הכוללת של הפרויקט הזה בקוד פתוח.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[[["התוכן קל להבנה","easyToUnderstand","thumb-up"],["התוכן עזר לי לפתור בעיה","solvedMyProblem","thumb-up"],["סיבה אחרת","otherUp","thumb-up"]],[["חסרים לי מידע או פרטים","missingTheInformationINeed","thumb-down"],["התוכן מורכב מדי או עם יותר מדי שלבים","tooComplicatedTooManySteps","thumb-down"],["התוכן לא עדכני","outOfDate","thumb-down"],["בעיה בתרגום","translationIssue","thumb-down"],["בעיה בדוגמאות/בקוד","samplesCodeIssue","thumb-down"],["סיבה אחרת","otherDown","thumb-down"]],["עדכון אחרון: 2025-07-25 (שעון UTC)."],[],["The technical writing project focuses on overhauling the Fastify documentation for the OpenJS Foundation. Key actions include creating a style guide, restructuring the existing documentation, and enhancing contribution content to improve clarity for new users. The project involves four phases: familiarization with tools and needs, structuring and prioritizing Fastify's goals, implementation with community feedback, and final review and reporting. The aim is to streamline the path from first-time contribution to understanding Fastify.\n"]]
