تحتوي هذه الصفحة على تفاصيل مشروع كتابة فني مقبول في موسم Google من المستندات.
ملخّص المشروع
- مؤسسة مفتوحة المصدر:
- CERN-HSF
- الكاتب الفني:
- LuckInTheRain
- اسم المشروع:
- مستندات ROOT: التحليل وإعادة الهيكلة وإعادة الكتابة
- مدة المشروع:
- الحمل لمدة طويلة (5 أشهر)
وصف المشروع
يتألّف المشروع من أربع مراحل:
1.) تحليل مستندات ROOT الحالية
يتم تحليل مستند ROOT الكامل (موقع الويب ودليل المستخدمين ومرجع C++ والبرامج التعليمية وما إلى ذلك) والتحقق منه وفقًا للمعايير التالية: البنية والتقسيم إلى وحدات، والتوحيد، وآليات الوصول، والاتساق، وأنواع المعلومات المستخدمة، والإعداد والفهم الخاص بالمجموعة المستهدفة. الهدف هو إنشاء مفهوم لإدارة المعلومات ومصفوفة للهيكلة وإرشادات لتوحيد المحتوى.
2- تحديد طريقة لتنظيم مستندات البرامج المكتوبة مع فريق ROOT
يتم تقديم DITA (Darwin Information Typing Architecture)، وهو معيار OASIS لمستندات البرامج (https://www.oasis-open.org/committees/dita/) إلى فريق ROOT. وينصبّ التركيز الرئيسي على فهم كيفية تنظيم المحتوى الخاص بالبرامج وكيفية استخدام أنواع المعلومات الأساسية مثل "المبدأ" و"المهمة" و"المرجع" لكتابة مستندات البرامج.
3- إعادة تنظيم مستندات ROOT
استنادًا إلى نتائج الخطوتَين الأولى والثانية، تتم إعادة هيكلة مستندات ROOT وتنظيمها إلى وحدات وفقًا للمجموعات المستهدَفة والأدوار وحالات الاستخدام، ويتم تخصيص المحتوى للعناصر (الموقع الإلكتروني ودليل المستخدمين ومرجع C++ والأدلة التعليمية وما إلى ذلك) وأنواع المحتوى المقابلة. وبما أنّ المعلومات المتاحة واسعة جدًا، يجب أيضًا إنشاء بنية مرجعية متّسقة. والهدف من ذلك هو تقديم نظرة عامة شاملة وعرض طرق واضحة للمستخدمين حول كيفية استخدام ROOT لتلبية احتياجاتهم. بالإضافة إلى ذلك، يتم تقديم مقدّمة موجزة غير مخصّصة للفيزياء.
4- إعادة كتابة مستندات ROOT
تتم إعادة كتابة الأجزاء الرئيسية من الوثائق، وخاصةً دليل المستخدمين، وفقًا لنهج DITA. ويتم تسجيل قواعد البنية والكتابة في دليل الأنماط لضمان الاتساق في المستندات في المستقبل. والهدف من ذلك هو تمكين فريق ROOT من توسيع نطاق مستندات ROOT وصيانتها بأنفسهم في المستقبل.
الجدول الزمني المقدَّر (5 أشهر):
المرحلة 1: تحليل مستندات ROOT الحالية: 3 أسابيع
المرحلة 2: تحديد طريقة لهيكلة وثائق برامج الكتابة مع فريق ROOT: أسبوعين.
المرحلة 3: إعادة هيكلة مستندات ROOT وتنظيمها: 4 أسابيع
المرحلة 4: إعادة كتابة مستندات ROOT: 11 أسبوعًا