تحتوي هذه الصفحة على تفاصيل مشروع كتابة فنية تم قبوله في "موسم مستندات Google".
ملخّص المشروع
- مؤسسة مفتوحة المصدر:
- VLC
- الكاتب الفني:
- Avii
- اسم المشروع:
- إنشاء مستندات مستخدم VLC لواجهة واحدة للأجهزة الجوّالة (Android)
- مدة المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
ABSTRACT
تُستخدَم مستندات المستخدمين كنظام دعم ثابت لمساعدة المستخدمين النهائيين. ويقدّم معلومات فنية وغير فنية عن منتج أو خدمة. تساعد المستخدمين على تعلم كيفية استخدام البرامج أو الخدمة. لا يريد بعض المستخدمين التواصل مع فريق الدعم أو الانتظار لتلقّي ردّ عبر البريد الإلكتروني إذا كان كل ما يحتاجونه هو بعض الإرشادات أو النصائح أو الحيل. وتعمل مستندات المستخدمين على تحقيق ذلك. كما أنّها تقلّل من تكاليف الدعم وتُظهر مدى كفاءة المنتج وفريق المطوّرين.
تم تنزيل VLC لنظام التشغيل Android أكثر من 100 مليون مرة من "متجر Google Play" وحده. يوفر برنامج VLC العديد من الميزات لمنافذ الأجهزة الجوّالة التي تشمل تشغيل الصوت والفيديو والبث عبر الشبكة. غالبًا ما يريد المستخدمون الاستفادة من هذه الميزات الرائعة ولكنّهم لا يستطيعون ذلك. ويتطلّب البحث عن مدونة أو فيديو عشوائي لإجراء ذلك الكثير من الوقت والصبر، ولا تزال هناك شكوك في صحة المعلومات التي يتم الحصول عليها. تستضيف VLC حاليًا مستندات مستخدمي VLC لنظام التشغيل Android على صفحة الموسوعة الإلكترونية، ولا تقدّم وصفًا لهذه الميزات أو تقدّم وصفًا بسيطًا لها. بالإضافة إلى ذلك، تم إجراء آخر تعديل على صفحات الموسوعة في آذار (مارس) 2019. سيقدّم المشروع الحالي مستندات جديدة للمستخدمين بتصميم حديث وسهولة أكبر في الاستخدام لإصدار Android.
الوضع الحالي
إنّ صفحات الموسوعة على الإنترنت قديمة تمامًا ولا تحتوي على معلومات قليلة جدًا عن أحدث إصدار من VLC. كما أنه ليس من السهل التنقل فيها. لا يتوفّر خيار مرئي لقراءة المستندات بلغة غير الإنجليزية. لا يحتوي على أوصاف للميزات على الإطلاق.
التحليل
-> في الوقت الحالي، أصبحت الوثائق الحالية قديمة ويجب كتابتها بطريقة جديدة واستخدام منصة وأدوات مختلفة.
-> لا يملك معظم مستخدمي Android معرفة فنية قليلة أو معدومة. ولكن هناك أشخاص يحتاجون إلى مزيد من المعلومات الفنية حول إحدى الميزات. إنّ كتابة مستندَين منفصلَين لكلّ من الأغراض المذكورة أعلاه والحفاظ عليهما ليس فكرة جيدة. وحتى في المستندات نفسها، يؤدي تقسيم إحدى الميزات استنادًا إلى المحتوى الفني وغير الفني إلى حدوث التباس إضافي. ولأنّ معظم المستخدمين معتادون على واجهة المستخدم التي يرونها أو الميزات التي يستخدمونها، ليس من السهل على الجميع تحديد ما إذا كان الأمر فنيًا أو غير فني. لذلك، نريد تبسيط هذه العملية لهم.
-> سيحاول معظم المستخدمين الحصول على المعلومات من خلال هواتفهم الذكية نفسها والباقي من خلال أجهزة الكمبيوتر المكتبي أو الأجهزة الأخرى. لذلك، يجب أن تكون المستندات قابلة للتكيّف بسهولة مع جميع أحجام الشاشات. ويجب ألا تؤدي إلى أي التباس بشأن التنقّل.
-> لا تتوفّر بعض ميزات إصدار الكمبيوتر المكتبي في إصدار Android، وإذا كانت متاحة، لا تعمل بالطريقة نفسها في كلا الإصدارَين. ويعود السبب في ذلك إلى أنّ تطبيق سطح المكتب كان قيد التطوير لفترة أطول بكثير وحقق نوعًا من التشبع، في المقابل، فإنّ إصدار الأجهزة الجوّالة جديد نسبيًا ولا يزال قيد التطوير. بخلاف ذلك، على الرغم من أن الأجهزة الجوّالة في هذه الأيام تصبح فعّالة للغاية، هناك قيود واضحة على نوع الميزات التي يمكننا دمجها بسبب طلب المستخدم النهائي. إنّ توفير ميزة لا يستخدمها أحد هو إهدار لموارد التطوير. لذلك، لا يُنصح بمقارنة كلا المستندَين استنادًا إلى الميزات.
استنادًا إلى التحليل أعلاه، نقترح ما يلي: 1. في الوقت الحالي، تستخدم مستندات مستخدمي أجهزة الكمبيوتر المكتبي أداة إنشاء مستندات Sphinx ومظهر Read the Docs. سيساعدنا استخدام الأسلوب نفسه في إصدار Android بالطرق التالية: -> دمج المستندَين بسهولة -> تم تحسينها لجميع أحجام الشاشات. -> تجربة سلسة عند الانتقال إلى مستندات مستخدمي Android من خلال مستندات أجهزة الكمبيوتر المكتبي
- فصل الفصول والأقسام والأقسام الفرعية حسب موضعها النسبي في التطبيق على سبيل المثال، يتوفّر وضع "التشغيل في الخلفية" أو "وضع الصورة في الصورة" ضمن "المزيد" -> الإعدادات -> الفيديو، لذا ستكون بنية الفصول على النحو التالي:
- المزيد
- |__الإعدادات
- | |__مكتبة الوسائط
- | |__الفيديو --> وضع "التشغيل في الخلفية" أو "صورة في صورة"
- : -> سيساهم هذا الأسلوب في تحسين سهولة الوصول، حيث سيتمكّن المستخدمون من الانتقال بسهولة إلى الجزء الذي يحتاجون إلى مساعدة من خلال مقارنته بالموقع الجغرافي النسبي في التطبيق. بالنسبة إلى كل ميزة، يمكننا فصل الأجزاء الفنية وغير الفنية بشكل أكبر. سنكتب أولاً وصفًا بسيطًا غير تقني، ثم نُبرز أو نضع تصنيفًا للجزء الفني من الميزة نفسها، إن توفّر، تحتها مباشرةً. قد يؤدي هذا إلى بعض التكرار ولكنه سيضمن تجربة سلسة للأغلبية غير الفنية. سيساعد ذلك أيضًا في المستقبل من خلال زيادة إمكانية الصيانة. ونظرًا لأن التطبيق سيصل إلى حالة التشبع، فمن غير المحتمل أن تتغير واجهة المستخدم النسبية بدرجة كبيرة، لذا في المستقبل، إذا تمت إضافة/إزالة ميزة جديدة، يمكننا ببساطة إعادة ضبط القسم. وفي حال تغيير واجهة المستخدم بالكامل، يمكننا إعادة ترتيب الأقسام/الفصول أو إعادة هيكلة المستند بأكمله، وفي كلتا الحالتين نحتاج إلى تعديل المستندات بأكملها لأنّه يجب استبدال لقطة الشاشة لتتطابق مع واجهة المستخدم الحالية. يمكنك العثور على عرض توضيحي هنا : https://avinal.gitlab.io/vlc-android-docs/
يجب أن يتضمّن كل قسم من الأقسام في المستندات لقطة شاشة مُصنَّفة ووصفًا للميزة وجزءًا أكثر تقنية إذا توفّر ونصائح وحيل حول الميزة.
-> سيساعدنا تطوير مستندات المستخدمين هذه بشكل مستقل من سطح المكتب على دمج المستندَين في بضع خطوات فقط بدون التأثير في المستندات الحالية أو التأثير فيها أثناء عملية التطوير. نقترح وضع هذه المستندات بالكامل في قسم Android من مستندات أجهزة الكمبيوتر المكتبي بعد تطويرها، ثم إنشاء رابط دائم لمستندات VLC لنظام التشغيل Android.
-> قد تشمل التحسينات الإضافية إعادة تصميم الصفحة الرئيسية لمستندات مستخدمي أجهزة الكمبيوتر المكتبي للسماح للمستخدمين باختيار نظام التشغيل المفضّل لديهم مباشرةً ثم إعادة التوجيه إلى مستندات نظام التشغيل المحدّد. بما أنّ وثائق مستخدمي VLC التي تعمل بأنظمة التشغيل Windows وMacOS وLinux قد تمّ تصميمها بشكل جيد وأُحيلنا إلى ذلك، قد نضيف خيارات للاختيار من بينها على Windows/MacOS/Linux أو Android أو iOS. سيؤدي ذلك إلى توفُّر مستندات مُنفصلة بشكل جيد ولكن موحّدة للمستخدمين باستخدام رابط واحد فقط لاستخدامه مع جميع المنافذ.
لماذا يُعدّ توثيق المستخدمين المقترَح أفضل مني؟ تم تنظيم مستندات المستخدم المقترَحة هذه استنادًا إلى الأنماط الشائعة التي يتّبعها المستخدم النهائي للحصول على المساعدة. تجمع المستندات جميع الميزات المطلوبة، مثل البساطة والوضوح والمظهر والشعور والمعرفة التكنولوجية لزيادة سهولة الاستخدام وتجربة المستخدم النهائي إلى أقصى حد. ويمكن أيضًا صيانته بسهولة نظرًا لعدم الحاجة إلى الاحتفاظ بمستندات المستخدم الفردية لكل منفذ.
لماذا أنا الشخص المناسب لهذا المشروع؟ -> لقد كنت أكتب الرموز البرمجية منذ عامَين، وغالبًا ما أحتاج إلى مراجعة مستندات واجهة برمجة التطبيقات لبعض المكتبات أو بعض البرامج أو حتى لتوثيق رمزي البرمجي. لذا أعرف بالضبط ما يريد الأشخاص رؤيته في الوثائق، والمشكلة التي يواجهونها، وكيف يتعاملون للحصول على المساعدة. سأتمكّن من تطبيق التجربة نفسها لكتابة مستندات متّسقة وسهلة القراءة.
-> لقد كنت أكتب بشكل نشط مواد فنية على Quora وStack Overflow ومنصات أخرى متنوعة. أعرف كيفية شرح الأمور بطريقة جذابة وسهلة الفهم.
-> برنامج VLC لأجهزة Android هو أداة قوية وشهيرة للغاية، إلّا أنّ معظم ميزاته إما غير معروفة أو لا تتوفّر أيّ مساعدة له. لقد كنت أستخدم VLC على كل من الأنظمة الأساسية لأجهزة الكمبيوتر المكتبي والأجهزة الجوّالة لعدة سنوات وأعرف المشاكل التي قد يواجهها المستخدم. من خلال الجمع بين كلّ معرفتي وخبرتي، يمكنني أن أضمن لك تقديم مستندات رائعة.