تحتوي هذه الصفحة على تفاصيل مشروع كتابة تقنيّة تم قبوله في موسم المستندات من Google.
ملخص المشروع
- المؤسسة المفتوحة المصدر:
- ScummVM
- الكاتب التقني:
- كادي
- اسم المشروع:
- إطلاق بوابة المستندات
- مدة المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
الأهداف:
- لإنتاج مستندات عالية الجودة ذات نُسخ متعددة للمستخدمين النهائيين من خلال دمج كميات كبيرة من المعلومات من مصادر مختلفة وإعادة كتابة المعلومات من أجل الوضوح والاتساق والاكتمال.
- يجب أن تكون المستندات سهلة الفهم بالنسبة إلى المبتدئين، بدون الاعتماد على المستخدمين المهتمين بالتكنولوجيا.
- لإنشاء بوابة وثائق باستخدام منشئ مواقع ثابتة.
- لوثائق المستخدمين النهائيين التي يمكن إكمالها في المستقبل من خلال إنشاء نماذج وتعليمات تفصيلية حول كيفية الاستفادة من المساهمين في البرامج المفتوحة المصدر في المستقبل.
الوضع الحالي:
- تنتشر وثائق ScummVM المتاحة عبر مصادر متعددة.
- يصعب العثور على المعلومات وغالبًا ما يتم تكرارها؛ فمن السهل أن تضيع في الصفحات الغامضة.
- من الصعب معرفة المعلومات الحديثة والمعلومات القديمة.
- بعض المعلومات مفقودة أو غير كاملة.
حلّ المشكلة:
هيكل التوثيق المقترح:
الصفحة المقصودة
|-- البدء
| -- Quick start guide
|-- Installing ScummVM
| |-- Nintendo 3DS
| |-- AmigaOS
| |-- Android
| |-- (every)
| |-- (common)
| |-- (supported)
|-- (المنصة)
|-- استخدام ScummVM
| |-- مشغّل التطبيقات
| |-- إعدادات عامة
| |-- إعدادات الألعاب
| -- Keyboard shortcuts
|-- Advanced options
| |-- Cloud and LAN
| |-- Control Mapping
| |-- Configuration
| |-- Command line options
| |-- Graphics
|-- الموسيقى والصوت
|-- المساعدة
| |-- الأسئلة الشائعة
| |-- جهات الاتصال
| |-- المشاكل المعروفة
| -- Reporting a bug
|-- Game Notes-- ملاحظات الإصدار
- الخطوات الأولى:
غالبًا ما يبحث المستخدمون الجدد عن دليل البدء السريع للمضي قدمًا في أسرع وقت ممكن. في حين أن تثبيت ScummVM قد يكون معقدًا على بعض الأنظمة الأساسية، فإن تثبيته على الكمبيوتر ليس أمرًا معقدًا.
يجب أن يتناول دليل البدء السريع ما يلي:
- كيفية تثبيت ScummVM على أنظمة التشغيل Windows وMac وLinux.
كيفية تحميل لعبة وإضافتها وتشغيلها
تثبيت ScummVM:
في الحالات التي لا يكون فيها التثبيت بديهيًا، أو التي قد لا يكون لدى المستخدم قاعدة فنية قوية، يحتاج المستخدم إلى دليل شامل لتثبيت ScummVM على أي من المنصات المتوافقة.
يجب أن تشمل كل صفحة تثبيت شاملة ما يلي:
- أي متطلبات للنظام أو متطلّبات أساسية
- كيفية تنزيل الإصدار المناسب من ScummVM.
- كيفية تثبيت ScummVM.
- كيفية تحميل الألعاب على المنصة التي تم اختيارها، خاصةً عندما لا تكون هي المنصة التي صُممت فيها اللعبة
كيفية تشغيل ScummVM وإضافة لعبة وتشغيل لعبة.
استخدام ScummVM:
يحتاج المستخدمون إلى مستندات مرجعية تشرح كيفية استخدام ScummVM.
يجب أن تشمل المستندات المرجعية ما يلي:
- واجهة "مشغّل التطبيقات"؛ الشكل الذي تظهر به كل نافذة وعلامة تبويب بالإضافة إلى طريقة عملها
- توضيح للإعدادات المتاحة، سواء العامة أو الخاصة بالألعاب.
اختصارات/مفاتيح التشغيل السريع للوحة المفاتيح.
الخيارات المتقدمة:
يحتاج المستخدمون المتقدّمون إلى مزيد من المعلومات الفنية حول الخيارات المتاحة لهم لتعديل طريقة تشغيل ألعابهم.
- ملاحظات اللعبة:
أي معلومات خاصة بالألعاب يحتاج المستخدم إلى معرفتها، بما في ذلك على سبيل المثال لا الحصر: - الجوانب غير المرغوب فيها في التثبيت - أي ملفات إضافية مطلوبة - عناصر تحكم غير معتادة أو مختلفة
- المشاكل المعروفة:
يجب أن يحتوي هذا القسم على أي أخطاء معروفة متعلقة بالإصدار.
- ملاحظات الإصدار:
على الرغم من أنّه سيتم إصدار نُسخ من مستنداتنا، قد يكون من المفيد توفُّر قسم "ملاحظات الإصدار" لتقديم ملخص للتغييرات في أحدث إصدار. قد يشمل ذلك بعض المجالات التي لا تشملها هذه المستندات حاليًا، مثل الألعاب المتوافقة حديثًا أو المعلومات حول المحرّكات الجديدة.
خطة الهجوم:
أقترح البدء بإنشاء نموذج لصفحات تثبيت ScummVM، حيث سيكون ذلك أسهل طريقة بالنسبة لي للحصول على المعلومات التي أطلبها من مشرفي/مطوري المنافذ (خاصةً عندما تكون هذه المعلومات قليلة أو غير موجودة). سأملأ مسبقًا أيّ معلومات لديّ من المستندات الحالية، ويمكن بعد ذلك التحقّق من اكتمالها ودقتها وعملتها، أو إضافتها إليها حسب الضرورة.
بعد ذلك، سأقوم بتحليل الوثائق الموجودة؛ ملف README، موقع wiki وموقع الويب. سأعيد كتابة كل قسم وأضيفه إلى كل قسم كما هو مطلوب وأسحب كل المعلومات إلى البوابة الجديدة. سأدوّن أيضًا المعلومات التي يتم استخراجها من الموقع الجغرافي، لضمان عدم ظهور أيّ حالات مضاعفة أو تناقضات أو أيّ حالات شاذة أخرى بعد نشر البوابة على الإنترنت.
وطوال هذا الوقت، سأتواصل مع المرشدين والمطوّرين ومسؤولي الحفاظ على المنافذ وأي خبراء في الموضوع الآخرين لمصدر أي معلومات مفقودة، بالإضافة إلى التأكد من أن كل صفحة حديثة وشاملة قدر الإمكان.
من منطلق روح التعاون ووفقًا لموافقة المرشدين، أود أن تكون بوابة العمل قيد التنفيذ متاحة لمنتدى ScummVM طوال عملية الكتابة، وذلك لتلقي الملاحظات في الوقت الفعلي وضمان عدم تفويت أي شيء طوال العملية.
أقترح استخدام دليل الأسلوب، مثل دليل الإرشادات حول مستندات مطوّري برامج Google، لضمان الاتّساق في مجموعة الأعمال هذه وجميع المستندات من الآن فصاعدًا.
حيثما أمكن، سأستخدم لقطات الشاشة وملفات GIF ووسائل المساعدة البصرية الأخرى لتحسين الفهم.
الجدول الزمني المقترح:
تعزيز الترابط بين أفراد المنتدى من 17 أغسطس حتى 13 سبتمبر 2020
استمر في قضاء الوقت في التحدث مع المرشدين ومجتمع ScummVM الأوسع لتحسين رؤية المشروع ووضع اللمسات الأخيرة على التفاصيل مثل هيكل المستند ومحتوى.
الأسبوع 1 من 14 سبتمبر إلى 20 سبتمبر
- أنشئ نموذجًا لصفحات التثبيت الخاصة بالنظام الأساسي.
- املأ النماذج مسبقًا بأي معلومات حالية ووزِّعها على المشرفين أو مطوّري البرامج المناسبين للحصول على مزيد من المعلومات.
الأسبوع 2 من 21 سبتمبر حتى 27 سبتمبر
- يمكنك إعداد البوابة الجديدة للوثائق.
الأسبوع 3 28 سبتمبر - 4 أكتوبر
استخدام ScummVM: - الواجهة - إعدادات عامة تثبيت ScummVM: - يتم إرجاع أدلة التثبيت الخاصة بالنظام الأساسي كنماذج مكتملة إليّ.
الأسبوع 4 5 أكتوبر - 11 أكتوبر
استخدام ScummVM: - إعدادات اللعبة - اختصارات لوحة المفاتيح تثبيت ScummVM: - يتم إرجاع أدلة التثبيت الخاصة بالنظام الأساسي كنماذج مكتملة إليّ
الأسبوع 5 12 أكتوبر - 18 أكتوبر
الخيارات المتقدّمة: - السحابة الإلكترونية وشبكة LAN - التحكّم في الربط تثبيت ScummVM: - يتم إرجاع أدلة التثبيت الخاصة بالنظام الأساسي كنماذج مكتملة إليّ
الأسبوع 6 19 أكتوبر - 25 أكتوبر
الخيارات المتقدّمة: - الضبط - خيارات سطر الأوامر تثبيت ScummVM: - يتم إرجاع أدلة التثبيت الخاصة بالنظام الأساسي عند عرض النماذج المكتملة
الأسبوع 7 26 أكتوبر - 1 نوفمبر
الخيارات المتقدمة: - الرسومات - الصوت تثبيت ScummVM: - يتم إرجاع أدلة التثبيت الخاصة بالنظام الأساسي حسب النماذج المكتملة إليّ
الأسبوع 8 2 نوفمبر - 8 نوفمبر
المساعدة: - الأسئلة الشائعة - جهات الاتصال - المشاكل المعروفة
تثبيت ScummVM: - يتم إرجاع أدلة التثبيت الخاصة بالنظام الأساسي كقوالب مكتملة إليّ
الأسبوع 9 9 نوفمبر - 15 نوفمبر
مساعدة: - الإبلاغ عن خطأ - ملاحظات حول اللعبة - ملاحظات الإصدار
تثبيت ScummVM: - ضع اللمسات الأخيرة على أي أدلة نظام أساسي لم تكتمل بعد.
الأسبوع 10 من 16 نوفمبر إلى 22 نوفمبر
- التعديل النهائي والتدقيق اللغوي ووضع اللمسات الأخيرة على أي قرارات متعلقة بالبوابة مثل التنقل في الشريط الجانبي وتعديلات المظهر/CSS وما إلى ذلك
- تأكَّد من أنّ جميع الروابط تعمل على النحو المتوقّع.
- تحقّق من عرض الصور أو ملفات GIF بشكل صحيح.
الأسبوع 11 من 23 نوفمبر حتى 30 نوفمبر
- ضَع اللمسات الأخيرة على أي عناصر معلّقة وإطلاق البوابة بشكل رسمي.
- بعد إطلاق البوابة، يُرجى إزالة المعلومات المتكررة من المصادر الأخرى بالتشاور مع الموجّهين.