تحتوي هذه الصفحة على تفاصيل مشروع كتابة تقنيّة تم قبوله في موسم المستندات من Google.
ملخص المشروع
- المؤسسة المفتوحة المصدر:
- موجا عالميًا
- الكاتب التقني:
- أنتوني
- اسم المشروع:
- توثيق رمز أداة إعداد التقارير
- مدة المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
وبما أن الفرصة متاحة لتوثيق "أداة إعداد التقارير" لمؤسسة Moja Global، أقترح تطوير 6 أنواع من الوثائق ستستخدمها الجماهير المختلفة لتحقيق أغراض مختلفة. وفيما يلي ملخّص لها:
1) دليل إعداد البيئة
1.1) مهندسو نظم الجمهور المستهدف
1.2) الهدف مساعدة مهندسي النظم في إعداد بيئة إنشاء وتنفيذ محلية لأداة إعداد التقارير.
1.3) تنسيق مقالة إرشادية توضح مجموعة الخطوات التسلسلية التي يجب على مهندسي النظم اتخاذها لإعداد البيئة التي ستساعد في إنشاء "أداة إعداد التقارير" وتشغيلها.
2) دليل الإنشاء
2.1) مهندسو نظم الجمهور المستهدف
2.2) الهدف مساعدة مهندسي النظام في إنشاء مكونات أداة إعداد التقارير من رمز المصدر
2.3) تنسيق مقالة إرشادية توضح مجموعة الخطوات التسلسلية التي يجب على مهندسي النظم اتّخاذها للحصول على رمز المصدر لأداة إعداد التقارير وتجميعه.
3) دليل التركيب
3.1 مهندسو نظم الجمهور المستهدَف
3.2) الهدف مساعدة مهندسي النظام في تثبيت مكوّنات حديثة لأداة إعداد التقارير
3.3) تنسيق مقالة إرشادية توضح مجموعة الخطوات التسلسلية التي يجب على مهندسي النظم اتّخاذها لنشر "أداة إعداد التقارير" في بيئة إعداد حديثة.
4) دليل التشغيل
4.1) شركات تكامل أنظمة الجمهور المستهدف
4.2) الهدف مساعدة مهندسي النظام في تشغيل نسخة مثبّتة حديثًا من أداة إعداد التقارير
4.3) تنسيق مقالة إرشادية توضّح مجموعة الخطوات التسلسلية التي يجب أن تتخذها جهات تكامل الأنظمة لتحميل قواعد بيانات مخرجات Flux ومعالجتها على مثيل "أداة إعداد التقارير" قيد التشغيل.
دليل التشغيل إعداد قواعد بيانات مخرجات التدفق ومعالجتها في أداة إعداد التقارير
5) دليل المستخدم
5.1) الجمهور المستهدف للمستخدمين النهائيين
5.2) الهدف مساعدة المستخدمين النهائيين في فهم الميزات المختلفة المضمّنة في "أداة إعداد التقارير" وكيفية استخدام هذه الميزات.
5.3) تنسيق مقالة طريقة التنفيذ توضح مجموعة الخطوات التسلسلية التي يجب على المستخدمين النهائيين اتخاذها لاستخدام وظائف "أداة إعداد التقارير" بشكل صحيح.
6) دليل التطوير
6.1) مبرمجو الجمهور المستهدف
6.2) الهدف مساعدة المستخدمين النهائيين على فهم الميزات المختلفة المضمّنة في "أداة إعداد التقارير" وكيفية استخدام هذه الميزات.
6.3) تنسيق المقالات المرجعية التي تصف: أ) عناصر التصميم الرئيسية التي تشكل الأداة ب) التحليل الوظيفي للعناصر المذكورة أعلاه ج) عناصر التنفيذ للعناصر المعطلة وظيفيًا د) رمز مصدر الأداة / مؤسسة المكتبات هـ) الرؤية والاتجاه الطويل الأمد للتحسين المستمر و) المجالات المنطقية التالية للتحسين
وبرنامج تعليمي قصير يصف كيف يمكن ضبط التعليمات البرمجية وفقًا للظروف الخاصة بالمستخدم