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