تحتوي هذه الصفحة على تفاصيل مشروع كتابة فنية تم قبوله في "موسم مستندات Google".
ملخص المشروع
- مؤسسة مفتوحة المصدر:
- ScummVM
- الكاتب الفني:
- Cadi
- اسم المشروع:
- إطلاق بوابة مستندات
- مدة المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
الأهداف:
- لإنشاء مستندات عالية الجودة ومتعدّدة الإصدارات للمستخدم النهائي من خلال تجميع كميات كبيرة من المعلومات من مصادر مختلفة وإعادة كتابة المعلومات لتحقيق الوضوح والاتساق والاكتمال.
- يجب أن تكون المستندات سهلة الفهم للمبتدئين، بدون أن تبدو متعجرفة للمستخدمين الملمّين بالتكنولوجيا.
- لإنشاء بوابة مستندات باستخدام أداة إنشاء مواقع ثابتة
- لإنشاء مستندات مناسبة للمستخدمين النهائيين في المستقبل من خلال إنشاء نماذج وإرشادات تفصيلية حول كيفية استخدام المساهمين في المستقبل للبرامج مفتوحة المصدر
الوضع الحالي:
- تتوفّر مستندات ScummVM في مصادر متعددة.
- من الصعب العثور على المعلومات، وغالبًا ما تكون مكرّرة، ومن السهل أن تضيع في صفحات غير واضحة.
- من الصعب معرفة المعلومات الحالية والمعلومات القديمة.
- بعض المعلومات غير متوفّرة أو غير مكتملة.
حلّ المشكلة:
بنية المستندات المقترَحة:
الصفحة المقصودة
|-- بدء الاستخدام
| -- Quick start guide
|-- Installing ScummVM
| |-- Nintendo 3DS
| |-- AmigaOS
| |-- Android
| |-- (every)
| |-- (common)
| |-- (supported)
|-- (platform)
|-- استخدام 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 أكتوبر
الخيارات المتقدّمة: - السحابة الإلكترونية وشبكة المنطقة المحلية - ربط عناصر التحكّم تثبيت 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 تشرين الثاني (نوفمبر)
- أكمِل أيّ إجراءات متبقّية وأطلق البوابة رسميًا.
- بعد إطلاق البوابة، عليك إزالة المعلومات المكرّرة من مصادر أخرى بالتشاور مع المرشدين.