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