پروژه آردوینو

این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.

خلاصه ی پروژه

سازمان منبع باز:

آردوینو

نویسنده فنی:

آقاسعد04

نام پروژه:

کتابخانه های شخص ثالث را مستند کنید

طول پروژه:

طول استاندارد (3 ماه)

شرح پروژه

من یک نویسنده فنی با تجربه هستم. من بیش از سه سال است که مستندات نرم افزاری با کیفیت بالا، راهنمای کاربر، راهنما، تحلیل الگوریتم، مستندات پروژه، مقاله تحقیقاتی می نویسم. در این پروژه، من تمام کتابخانه های شخص ثالث را مستند خواهم کرد. هدف من مستندسازی کتابخانه‌هایی است که توسط آردوینو ساخته شده‌اند و کمک می‌کنند تا تمام پتانسیل‌های آن‌ها در معرض دید توسعه‌دهندگان قرار گیرد. من وظایف زیر را انجام خواهم داد:

مستندسازی عملکرد کتابخانه مستندسازی چگونگی بهبود کتابخانه ها برای پاسخگویی به نیازهای مورد نیاز

مثلا

کتابخانه NESController آردوینو واقعاً باید به خوبی مستند باشد. ویژگی ها، سازگاری، نمونه ها، برنامه های کاربردی آن باید در مستندات آن برای مشارکت کنندگان آن اضافه شود. استفاده قبلاً در اسناد ذکر شده است که می تواند تا حد زیادی بهبود یابد. Nbiot-arduino یک کتابخانه آردوینو برای دسترسی به ماژول های NBIoT است. اسناد آن را می توان با گسترش گزینه های استفاده، ساخت و آزمایش، اشکال زدایی آن بهبود بخشید. نمونه های حاوی قطعه کد نیز باید گنجانده شوند. ستاره دارترین کتابخانه آردوینو ArduinoJson به خوبی مستند شده است به عنوان نمونه هایی که نحوه استفاده از کتابخانه را در ایستگاه های مختلف نشان می دهد، مرجع API حاوی توضیحات هر کلاس و عملکرد، پرسش های متداول که تقریباً به هر سوال پاسخ می دهد و دستیار AduinoJson که برنامه ها را برای کاربران خود می نویسد شامل می شود. در مستندات به همین ترتیب، مستندسازی عمیق باید برای تمام کتابخانه‌هایی که اسنادشان نیاز به بهبود و توسعه دارند، انجام شود. من با تجربه در زمینه اینترنت اشیا (IoT)، دانش اولیه در مورد میکروکنترلرها را دارم. من به زبان های برنامه نویسی مختلف از جمله پایتون، جاوا، سی، سی پلاس پلاس، HTML5، جاوا اسکریپت، سی شارپ تسلط دارم. من بسیار علاقه مند و مایلم از طریق مهارت های نوشتاری فنی و دانش در مورد الکترونیک، میکروکنترلرها و برنامه نویسی به آردوینو کمک کنم. من مشتاق یادگیری بیشتر و افزایش مهارت ها و دانش خود هستم.

من از 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 بسیار روشن است. در پروژه های دیگر نیز به سازمان کمک خواهم کرد. من سعی خواهم کرد آن را در همه جنبه ها از دیدگاه اسناد تا دیدگاه امنیتی کامل کنم. اگر فرصتی پیدا کنم حتما در هر جلسه سازمان شرکت خواهم کرد.

شرایط و ضوابط

من کاملا موافقم که به روشی که در بالا توضیح دادم کار کنم و در صورت سقط جنین پاسخگو باشم. فداکاری لازم برای این پروژه را درک می کنم، به شما اطمینان می دهم که تمام فصل خود را وقف این پروژه می کنم تا بتوانم بهترین کار را ارائه دهم.

از شما برای خواندن کل پیشنهاد سپاسگزارم. لطفا در صورت وجود هرگونه سوال بیشتر با من تماس بگیرید.