تحتوي هذه الصفحة على تفاصيل مشروع كتابة تقنيّة تم قبوله في موسم المستندات من Google.
ملخص المشروع
- المؤسسة المفتوحة المصدر:
- CERN-HSF
- الكاتب التقني:
- LuckInTheRain
- اسم المشروع:
- مستندات ROOT: التحليل وإعادة الهيكلة وإعادة الكتابة
- مدة المشروع:
- الجري الطويل (5 أشهر)
وصف المشروع
يتكون المشروع من أربع مراحل:
1.) تحليل وثائق ROOT الحالية
يتم تحليل مستند ROOT الكامل (موقع إلكتروني ودليل المستخدمين ومرجع C++ والبرامج التعليمية وما إلى ذلك) والتحقّق منه وفقًا للمعايير التالية: البنية، والتقسيم إلى وحدات، وتوحيد، وآليات الوصول، والاتساق، وأنواع المعلومات المستخدَمة، والتحضير والفهم لمجموعة مستهدفة معيّنة. الهدف هو وضع مفهوم لإدارة المعلومات ومصفوفة للهيكلة وإرشادات لتوحيد المحتوى.
2.) تحديد طريقة لهيكلة وثائق برنامج الكتابة مع فريق ROOT
يتم تقديم DITA (بنية دارون لكتابة المعلومات)، وهو معيار 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: إعادة هيكلة مستندات الجذر وإعادة تنظيمها: 4 أسابيع
المرحلة 4: إعادة كتابة مستند الجذر: 11 أسبوعًا