تحتوي هذه الصفحة على تفاصيل مشروع كتابة تقنيّة تم قبوله في موسم المستندات من 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. سأستمر في المساهمة في المؤسسة في مشاريع أخرى أيضًا. سأحاول جعله مثاليًا في جميع الجوانب، من منظور التوثيق إلى المنظور الأمني. سأحضر بالتأكيد أي اجتماع للمؤسسة إذا سنحت لي الفرصة.
الأحكام والشروط
أوافق رسميًا على أنني سأعمل بنفس الطريقة التي أوضحتها أعلاه، وفي حال حدوث أي إجهاض، سأكون مسئولاً عن ذلك. أتفهم التفاني المطلوب لهذا المشروع، وأؤكد لك أنني أخصص موسمي بأكمله لهذا المشروع حتى أتمكن من تقديم أفضل عمل.
شكرًا لك على قراءة الاقتراح بالكامل. يُرجى التواصل معنا إذا كانت لديك أي استفسارات أخرى.