تحتوي هذه الصفحة على تفاصيل مشروع كتابة فني مقبول ضمن "موسم المستندات" من 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) تنسيق المقالات المرجعية التي تصف: أ) عناصر التصميم الرئيسية التي تشكل الأداة ب) التحليل الوظيفي للعناصر المذكورة أعلاه ج) عناصر التنفيذ للعناصر المتحللة وظيفيًا د) رمز المصدر للأداة / مؤسسة المكتبات هـ) الرؤية والاتجاه الطويل الأمد للتحسين المستمر و) المجالات المنطقية التالية للتحسين
وبرنامج تعليمي قصير يصف كيف يمكن تعديل التعليمة البرمجية وفقًا للظروف الخاصة بالمستخدم