تحتوي هذه الصفحة على تفاصيل مشروع كتابة فنية تم قبوله في "موسم مستندات Google".
ملخّص المشروع
- مؤسسة مفتوحة المصدر:
- Kolibri
- الكاتب التقني:
- StephDix
- اسم المشروع:
- أسلوب مستندات منظومة Kolibri المتكاملة واصطلاحات سير العمل
- مدة المشروع:
- الحمل لمدة طويلة (5 أشهر)
وصف المشروع
ملخص
يوضّح هذا المستند تفاصيل تنفيذ إرشادات الأسلوب وإدارة سير العمل في المعلومات الموثَّقة التي تقدّمها Learning Equality لمشروع Kolibri Ecosystem.
نظرة عامة
يتألف اقتراحنا من أربع مراحل. في المرحلة الأولى، سأكمل دليل تنسيق مستندات LE مع إرشادات تسهيل الاستخدام واقتراحات الكتابة والتنسيق وفقًا لمفاهيم LE وإرشادات التنسيق في تطوير البرامج. في المرحلة الثانية، سأجري تدقيقًا لجودة مستندات ReadThe Docs وGoogle Docs. تدمج خطة التدقيق استخدام قوائم التحقّق لتقييم الامتثال لإرشادات الأسلوب. ستساعد قوائم التحقق هذه في تسجيل النتائج وتطبيق التغييرات على الوثائق. في المرحلة الثالثة، سأعمل على بنية النماذج وشكلها وأسلوبها من مستندات ReadTheDocs و"مستندات Google". سأنشئ مستودعًا للنماذج والصور في Google Drive يحدِّد كل فئة من فئات النماذج لأنواع المستندات الرئيسية لإعادة استخدامها في عمليات التنفيذ القادمة. سأكمل هذه المهمة من خلال إنشاء نماذج لإرسال مشاكل المستندات لتسهيل التعرّف عليها في مراجعات طلبات الجذب. وأخيرًا، سأقوم بإنشاء دليل "المساهمون" الذي يجمع موارد مفيدة لكل مجموعة من المتعاونين لتحسين تجربتهم في الوصول إلى المعلومات.
الغرض والنطاق
الهدف من خطة التنفيذ هذه هو تحسين تجربة المستخدمين النهائيين الذين يستخدمون مستندات Kolibri ومساعدة أعضاء الفريق والمساهمين على إنتاج وثائق أفضل والتعاون الفعّال في المجتمع. ينطبق هذا التنفيذ على ReadTheDocs والمجموعات الفرعية من مستندات "مستندات Google" في منظومة Kolibri المتكاملة.
الجمهور
يشير ذلك المصطلح إلى الجمهور الأساسي من القائمين بالتنفيذ والمشرفين والمستخدمين النهائيين، ويمثّلون المستهلكين الأكثر أهمية لمستندات Kolibri. جمهور ثانوي من أعضاء الفريق والمتعاونين لإنتاجهم واستخدامهم لوثائق Kolibri
الأهداف
يتوقع دليل الأنماط ونظام سير العمل لمستندات منظومة Kolibri المتكاملة من المستخدمين ما يلي: إنشاء مستندات سهلة الهضم بلغة سهلة الفهم وتنسيق متّسق. الحفاظ على ممارسات الجودة عند إعداد المستندات سهِّل الوصول إلى المعلومات بين قنوات التوثيق. تعزيز المبادرات التعاونية في منتدى Kolibri المفتوح المصدر
مصادر المعلومات
كانت مصادر المعلومات التي استخدمتها هي Kolibri وKolibri Studio ومستندات RTD لتطوير Kolibri وKolibri Toolkits من Google Drive.
لقد كانت "رادينا ماتيش" الرائعة من المساعدة الكبيرة في تقديم أنشطة الإحماء والأنشطة الخاصة بالمشروع. ساعدتني ملاحظاتها حول ما تحدّده المؤسسة على أنّه ""إرشادات"" و ""أدلة"" وحول توفّر دليل للمشاركين في تنظيم أفكاري وصياغة الاستنتاجات.
البرامج
سأقوم بتطوير مسودة دليل الأسلوب في مستندات Google. إنّ منصة المستندات هذه مثالية لإعادة الصياغة عندما تكون جاهزة للنشر. بالنسبة إلى تدقيق مراقبة الجودة، سأستخدم "نماذج Google" لإجراء التقييم للمستندات. سيقوم جدول البيانات بتخزين الردود على النموذج للتحكم في المستندات. سأعيد صياغة مستندات RTD باستخدام GitHub. لقد عملت مع Git وGitkraken وGitHub وGitlab. لديّ معرفة جيدة بلغة Markdown وبعض تنسيقات RestructuredText. أخطّط للمساهمة في إصلاحات المستندات لمواصلة تعلُّم البنية. سأستخدم Sharex للصور وملفات GIF. أحب هذه الأداة لأنّها تُنشئ تنسيقات مختلفة للإخراج. سأستخدم "المخططات البيانية" لإنشاء المخططات البيانية وتعديل الصور. يتكامل برنامج الرسوم التخطيطية بشكل رائع مع Google Docs وGoogle Drive وLibreOffice. حالة الوثائق في مرحلة الاستكشاف، قمت بمراجعة معظم وثائق كوليبري. لقد عثرت على أخطاء نحوية وإملائية وعدم اتساق في التنسيق والطباعة واستخدام الصور، بالإضافة إلى مسارات مستندات مربكة في معظم مستندات المشروع. على سبيل المثال، في دليل مستخدم Kolibri، يُعدّ قسم تحديد المشاكل وحلّها موضوعًا فرعيًا وليس موضوعًا رئيسيًا. وتكون هذه المعلومات بالغة الأهمية بما يكفي للمستخدمين النهائيين للوصول إليها من جدول المحتويات. وكبديل ثانٍ، يمكنهم استخدام شريط البحث وشجرة جدول المحتويات لتوسيع المواضيع الأخرى والعثور على مقالات تحديد المشاكل وحلّها.
للوصول إلى قسم "استكشاف الأخطاء وإصلاحها"، يجب عليك إما البحث عنه أو توسيع "إدارة Kolibri" لإدراك أن استكشاف الأخطاء وإصلاحها موجود كجزء من الوثائق. الدليل مقابل الإرشادات في ما يتعلّق بمقترح المشروع هذا، حلّلتُ مستندَين: دليل أسلوب مستندات مستخدمي LE Kolibri وإرشادات ترجمة LE. في دليل LE Kolibri، قدّمت اقتراحات وتعليقات من مخطّط المستندات ومخطّط الموضوع المقترَح، بالإضافة إلى بعض العناصر الأخرى التي تحتاج إلى تحسين في الدليل. لقد غيّرتُ التنسيق والأسلوب في إرشادات LE Translation Guidelines استنادًا إلى اقتراحاتي والاصطلاحات الحالية الواردة في "دليل الأسلوب". ما لفت انتباهي أثناء التحليل هو المفهوم الخاطئ الذي يميز المستندات المصنّفة على أنّها إرشادات وأدلة.
النتائج
لقد أجريتُ فحص جودة لدليل الترجمة في "إعلانات شبكة البحث" بالإضافة إلى اقتراحات وتعليقات باستخدام نموذج أولي أشرحه بالتفصيل في مهمة "تدقيق ضمان الجودة". في ما يلي بعض التعليقات النهائية التي تم الحصول عليها من التقييم: الروابط غير الصالحة لموقع ICU Syntax .js الإلكتروني التنسيق المستخدَم لإنشاء هذه الإرشادات غير صحيح. المستند هو دليل، وليس إرشادات. أسلوب الخط غير متسق استخدام العناوين بشكل غير صحيح، استخدام اللغة بشكل غير لائق وإساءة استخدام الكلمات المختصرة الاستخدام غير الملائم للنصوص البديلة الجمل أو التعليمات المتكرّرة
تعد النتائج لكلا المستندين جزءًا من المُخرَجات النهائية لهذا العرض.
المهام المتعلّقة بالمشروع
- اقتراحات بشأن دليل الأسلوب لمستندات المستخدمين بشأن LE (التعليقات)
- إرشادات الترجمة في "إعلانات شبكة البحث" بتنسيقات وأنماط جديدة
- مخطّط الموضوع
- الجدول الزمني للمشروع
- مهام التوثيق