پروژه آردوینو
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد 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: 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'19 بسیار روشن است. در پروژه های دیگر نیز به سازمان کمک خواهم کرد. من سعی خواهم کرد آن را در همه جنبه ها از دیدگاه اسناد تا دیدگاه امنیتی کامل کنم. اگر فرصتی پیدا کنم حتما در هر جلسه سازمان شرکت خواهم کرد.
شرایط و ضوابط
من کاملا موافقم که به روشی که در بالا توضیح دادم کار کنم و در صورت سقط جنین پاسخگو باشم. فداکاری لازم برای این پروژه را درک می کنم، به شما اطمینان می دهم که تمام فصل خود را وقف این پروژه می کنم تا بتوانم بهترین کار را ارائه دهم.
از شما برای خواندن کل پیشنهاد سپاسگزارم. لطفا در صورت وجود هرگونه سوال بیشتر با من تماس بگیرید.
محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است، مگر غیر از این ذکر شده باشد. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی."],[[["\u003cp\u003eThis Google Season of Docs project focuses on improving the documentation of third-party libraries used within the Arduino ecosystem.\u003c/p\u003e\n"],["\u003cp\u003eThe project aims to create comprehensive documentation, including features, installation instructions, contribution guidelines, and support information for each library.\u003c/p\u003e\n"],["\u003cp\u003eThe technical writer, AghaSaad04, has extensive experience in technical writing and possesses relevant knowledge of programming languages and micro-controllers.\u003c/p\u003e\n"],["\u003cp\u003eA standardized template will be used for documenting the libraries, ensuring consistency and clarity.\u003c/p\u003e\n"],["\u003cp\u003eThe project will involve a significant time commitment, with the writer dedicating 45+ hours per week and maintaining regular communication with their mentor.\u003c/p\u003e\n"]]],["The project aims to improve documentation for Arduino's third-party libraries. The technical writer, AghaSaad04, will document library workings and improvements, focusing on Arduino-made and contributed libraries. Key actions include creating in-depth documentation for each library, including features, installation, contribution guidelines, support, and licensing, using a provided Markdown template. The writer will dedicate 45+ hours weekly, communicating updates via email and Team Viewer with the mentor. The project will be standard length (3 months).\n"],null,["# Arduino project\n\nThis page contains the details of a technical writing project accepted for\nGoogle Season of Docs.\n\nProject summary\n---------------\n\nOpen source organization:\n: Arduino\n\nTechnical writer:\n: AghaSaad04\n\nProject name:\n: Document third-party libraries\n\nProject length:\n: Standard length (3 months)\n\nProject description\n-------------------\n\nI am an experienced technical writer. I have been writing high quality software documentation, user-guides, manuals, algorithm analysis, project documentation, research paper for more than three years.\nIn this project, I will document all the third-party libraries. I aim to document the libraries that are Arduino-made and contributed so that all their potential is exposed towards developers. I will accomplish the following tasks:\n\nDocument the working of the library\nDocument how to Improve the libraries to make them accommodate the required needs\n\n### For Example\n\nArduino's NESController library really needs to be well-documented. Its features, compatibility, examples, applications should be added in its documentation for its contributors. Usage is already mentioned in the documentation which can be improved to a greater extent. Nbiot-arduino is an Arduino Library for accessing NBIoT modules. Its documentation can be improved by extending its Usage, Build \\& Test, Debug Options. Examples containing code snippets should also be included.\nArduino's most starred library ArduinoJson is well-documented as examples showing how to use the library in various stations, API Reference containing the description of each class and function, FAQ that answers to virtually every question and AduinoJson Assistant which writes programs for its users are included in the documentation. Similarly, in-depth documentation should be done for all the libraries whose documentation needs to be improved and extended.\nBeing experienced in the field of Internet of Things (IoT), I have the basic knowledge about micro-controllers. I have proficiency in various programming languages including Python, Java, C, C++, HTML5, JavaScript, C#. I am highly interested and willing to contribute to Arduino through my technical writing skills and the knowledge about electronics, micro-controllers, programming. I am eager to learn more and enhance my skills and knowledge.\n\nI will be using Markdown for styling of all my writing due to its easy-to-use syntax and extensive set of features.\n\n### Template\n\nThis is one of the templates that can be used for the documentation. It can be modified and new sections can be added according to the requirements of the document. \n\n\n $projectName/Library Name\n --------\n In this section, I will give background information of the library, \n what does this library use, on what languages and framework it is based on, \n what are the dependencies of this library/project where it will be used\n\n Features\n --------\n I will add features of the project here like\n - this library creates connection between server and client\n - Make things faster\n\n Installation\n ------------\n In this section I will add the installation procedure and dependencies that \n needs to be installed.\n Install $project by running:\n install project\n\n Contribute\n ----------\n For the contributors, I will add this section in documentation.\n - Issue Tracker: github.com/$project/$project/issues\n - Source Code: github.com/$project/$project\n\n Support\n -------\n This section can also be added\n If you are having issues, please let us know.\n We have a mailing list located at: project@google-groups.com\n\n License\n -------\n This section will tell about the license of the project.\n This project is licensed under the BSD.\n\n### Time commitment and communication\n\nI will give 45+ hours a week but in case of any mishap, I will compensate those\nhours on weekends.During the community bond period, I will discuss communication means and will finalize weekly meetings, means and time for those meetings with my mentor. I will keep my mentor up to date about my work; will share my work details via email to my mentor. I will prefer Team Viewer for communicating, as it is easy to use with lots of features like share screens etc.\n\n### Future Plans\n\nMy future plans are very clear, after GSoD'19. I will keep contributing to the organization in other projects too. I will try to make it perfect in all aspects from documentation perspective to security perspective. I will surely attend any meeting of the organization if I ever get a chance.\n\n### Terms \\& Conditions\n\nI solemnly agree that I will work in the same way that I have explained above and\nin case of any miscarriage, I will be held accountable. I understand the dedication\nrequired for this project, I assure you that I am dedicating my whole season for this project so that I can provide the best work.\n\nThank you for reading the whole proposal. Please reach out to me if there are any further queries."]]
