פרויקט Arduino

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

סיכום הפרויקט

ארגון הקוד הפתוח:

ארדינו

כתב טכני:

AghaSaad04

שם הפרויקט:

ספריות מסמכים של צד שלישי

אורך הפרויקט:

אורך רגיל (3 חודשים)

תיאור הפרויקט

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

מתעדים את פעולת הספרייה איך משפרים את הספריות כך שיענו על הצרכים הנדרשים

לדוגמה

ספריית ה-eSIM של Arduino צריכה להיות מתועדת היטב. את התכונות, התאימות והדוגמאות של האפליקציות יש להוסיף לתיעוד שלהן עבור השותפים ביצירת התוכן. השימוש כבר מוזכר בתיעוד, וניתן לשפר אותו במידה רבה יותר. Nbiot-arduino היא ספריית Arduino שמאפשרת גישה למודולים של NBIoT. ניתן לשפר את התיעוד שלה על ידי הרחבת אפשרויות השימוש, הבנייה והבדיקה וניפוי הבאגים. יש לכלול גם דוגמאות המכילות קטעי קוד. ספריית 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: [e-mail]

License
-------
This section will tell about the license of the project.
This project is licensed under the BSD.

מחויבות לזמן ותקשורת

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

תוכניות לעתיד

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

תנאים והגבלות

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

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