تحتوي هذه الصفحة على تفاصيل مشروع كتابة فني مقبول في موسم Google من المستندات.
ملخّص المشروع
- مؤسسة مفتوحة المصدر:
- Arduino
- الكاتب الفني:
- AghaSaad04
- اسم المشروع:
- توثيق المكتبات التابعة لجهات خارجية
- مدة المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
أنا كاتب فني ذو خبرة. لقد كنت أكتب منذ أكثر من ثلاث سنوات مستندات برامج عالية الجودة وأدلة المستخدمين والأدلة وتحليل الخوارزميات ومستندات المشاريع والأوراق البحثية. في هذا المشروع، سأوثق جميع مكتبات الجهات الخارجية. أهدف إلى توثيق المكتبات التي أنشأها فريق Arduino والمساهمات التي تم تقديمها فيها حتى يتم الكشف عن كل إمكاناتها للمطوّرين. سأنجز المهام التالية:
توثيق عمل المكتبة توثيق كيفية تحسين المكتبات لاستيعاب الاحتياجات المطلوبة
على سبيل المثال
يجب أن تكون مكتبة NESController من Arduino موثقة جيدًا. ويجب إضافة ميزاته وتوافقه وأمثلةه وتطبيقاته إلى وثائقه للمساهمين فيه. تم ذكر الاستخدام في المستندات التي يمكن تحسينها بشكل أكبر. Nbiot-arduino هي مكتبة Arduino للوصول إلى وحدات NBIoT. يمكن تحسين مستنداتها من خلال توسيع نطاق خيارات الاستخدام والإنشاء والاختبار وتصحيح الأخطاء. يجب أيضًا تضمين أمثلة تحتوي على مقتطفات رمز. إنّ مكتبة ArduinoJson هي المكتبة التي حصدت أكبر عدد من التقييمات الإيجابية في Arduino، وهي موثّقة جيدًا، إذ تتضمّن أمثلة توضّح كيفية استخدام المكتبة في محطات مختلفة، ومراجع لواجهة برمجة التطبيقات تحتوي على وصف كل فئة ووظيفة، وأسئلة شائعة تجيب عن كل سؤال تقريبًا، و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. سأواصل المساهمة في المؤسسة من خلال مشاريع أخرى أيضًا. سأحاول جعله مثاليًا من جميع الجوانب، بدءًا من التوثيق ووصولاً إلى الأمان. سأحضر بالتأكيد أي اجتماع للمؤسسة إذا سنحت لي الفرصة.
الأحكام والشروط
أؤكّد بموجب هذا العقد أنّني سأعمل بالطريقة نفسها الموضّحة أعلاه، وإذا حدث أيّ خطأ، سأتحمل مسؤولية ذلك. أتفهّم الجهد المبذول في هذا المشروع، وأؤكّد لك أنّني سأكرّس موسمي بالكامل لهذا المشروع لأقدّم أفضل عمل ممكن.
شكرًا لك على قراءة الاقتراح بالكامل. يُرجى التواصل معنا إذا كانت لديك أي استفسارات أخرى.