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