בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.
סיכום הפרויקט
- ארגון קוד פתוח:
- Arduino
- כותבים טכניים:
- AghaSaad04
- שם הפרויקט:
- תיעוד ספריות של צד שלישי
- אורך הפרויקט:
- אורך רגיל (3 חודשים)
תיאור הפרויקט
יש לי ניסיון רב ככותב טכני. אני כותב מסמכי תיעוד של תוכנות, מדריכים למשתמש, מדריכים, ניתוח אלגוריתמים, מסמכי תיעוד של פרויקטים ומאמרי מחקר באיכות גבוהה כבר יותר משלושה שנים. בפרויקט הזה אתיעד את כל הספריות של צד שלישי. המטרה שלי היא לתעד את הספריות שנוצרו על ידי Arduino ותרמו לפרויקט, כדי שכל הפוטנציאל שלהן יהיה חשוף למפתחים. אעשה את המשימות הבאות:
תיעוד של אופן הפעולה של הספרייה תיעוד של אופן השיפור של הספריות כך שיתאימו לצרכים הנדרשים
לדוגמה
ספריית NESController של Arduino צריכה להיות מתועדת היטב. התכונות, התאימות, הדוגמאות והאפליקציות של הספרייה צריכות להתווסף למסמכי התיעוד שלה למשתתפים. השימוש כבר מוזכר במסמכי העזרה, אבל אפשר לשפר אותם עוד יותר. Nbiot-arduino היא ספריית Arduino לגישה למודולים של NBIoT. אפשר לשפר את המסמכים על ידי הרחבת האפשרויות של 'שימוש', 'פיתוח ובדיקה' ו'ניפוי באגים'. כדאי לכלול גם דוגמאות שמכילות קטעי קוד. הספרייה של Arduino עם מספר הכוכבים הגבוה ביותר היא ArduinoJson, והיא כוללת מסמכי עזרה עם דוגמאות לשימוש בספרייה בתחנות שונות, מדריך API שמכיל תיאור של כל כיתה ופונקציה, שאלות נפוצות עם תשובות כמעט לכל שאלה ו-AduinoJson Assistant שכותב תוכניות למשתמשיו. באופן דומה, צריך להכין תיעוד מעמיק לכל הספריות שצריך לשפר ולרחיב את התיעוד שלהן. יש לי ניסיון בתחום האינטרנט של הדברים (IoT), ויש לי ידע בסיסי בנושא מיקרו-בקרים. יש לי ידע בשפות תכנות שונות, כולל Python, Java, C, C++, HTML5, JavaScript ו-C#. יש לי עניין רב ומוכן לתרום ל-Arduino דרך מיומנויות הכתיבה הטכניות והידע שלי לגבי אלקטרוניקה, מיקרו-בקרים ותכנות. אני רוצה ללמוד עוד ולשפר את המיומנויות והידע שלי.
אשתמש ב-Markdown כדי לעצב את כל הטקסטים שלי בגלל התחביר הקל לשימוש והמגוון הרחב של התכונות.
תבנית
זו אחת מהתבניות שאפשר להשתמש בהן לצורך תיעוד. אפשר לשנות אותו ולהוסיף קטעים חדשים בהתאם לדרישות של המסמך.
$projectName/Library Name
--------
In this section, I will give background information of the library,
what does this library use, on what languages and framework it is based on,
what are the dependencies of this library/project where it will be used
Features
--------
I will add features of the project here like
- this library creates connection between server and client
- Make things faster
Installation
------------
In this section I will add the installation procedure and dependencies that
needs to be installed.
Install $project by running:
install project
Contribute
----------
For the contributors, I will add this section in documentation.
- Issue Tracker: github.com/$project/$project/issues
- Source Code: github.com/$project/$project
Support
-------
This section can also be added
If you are having issues, please let us know.
We have a mailing list located at: project@google-groups.com
License
-------
This section will tell about the license of the project.
This project is licensed under the BSD.
התחייבות לזמן ותקשורת
אקדיש לכך יותר מ-45 שעות בשבוע, אבל אם יהיו בעיות אצטרך לפצות על השעות האלה בסופי שבוע.במהלך תקופת ההתחייבות לקהילה, אדבר עם המנטור שלי על אמצעי התקשורת ואאשר את הפגישות השבועיות, אמצעי התקשורת והשעה שלהן. אעדכן את המנטור שלי לגבי העבודה שלי ואשתף את פרטי העבודה שלי באימייל עם המנטור. אני מעדיף להשתמש ב-Team Viewer לתקשורת כי היא קלה לשימוש ויש בה הרבה תכונות כמו שיתוף מסכים וכו'.
תוכניות עתידיות
התוכניות שלי לעתיד ברורות מאוד, אחרי GSoD 2019. אני אמשיך לתרום לארגון גם בפרויקטים אחרים. אנסה להפוך אותו למושלם בכל ההיבטים, מנקודת מבט של תיעוד ועד לנקודת מבט של אבטחה. אם תהיה לי הזדמנות, אשתתף בכל פגישה של הארגון.
תנאים והגבלות
אני מאשר/ת בזאת באופן סופי שאעבוד באותו אופן שמוסבר למעלה, ובמקרה של הפלה, אהיה אחראי/ת לכך. ברור לי כמה מאמץ נדרש כדי להצליח בפרויקט הזה, ואני מבטיח לך שאקדיש את כל העונה לפרויקט הזה כדי שאוכל לספק את העבודה הטובה ביותר.
תודה שקראת את כל ההצעה. אם יש לך שאלות נוספות, אפשר לפנות אליי.