تحتوي هذه الصفحة على تفاصيل مشروع كتابة تقنيّة تم قبوله في موسم المستندات من Google.
ملخص المشروع
- المؤسسة المفتوحة المصدر:
- VLC
- الكاتب التقني:
- أفي
- اسم المشروع:
- إنشاء مستندات مستخدم VLC لمنفذ واحد للأجهزة الجوّالة (نظام التشغيل Android)
- مدة المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
تجريدي
تُستخدم وثائق المستخدم كنظام دعم ثابت لمساعدة المستخدمين. يوفّر هذا الدليل معلومات تقنية وغير تقنية حول منتج أو خدمة. يساعد المستخدمين في تعلم كيفية استخدام البرامج أو الخدمات. لا يريد كل شخص التواصل مع فريق الدعم أو انتظار ردّ عبر البريد الإلكتروني إذا كان كل ما يحتاج إليه هو توجيه بعض التوجيهات أو النصائح أو الخدعة. تقوم وثائق المستخدم بذلك فقط. كما أنه يقلل من تكاليف الدعم ويمثل هوية سلامة المنتج وفريق المطورين.
تم تنزيل برنامج VLC لنظام التشغيل Android أكثر من 100 مليون مرة من "متجر Google Play" وحده. يوفر VLC الكثير من الميزات لمنافذ الجوّال بدءًا من تشغيل الصوت والفيديو إلى بث الشبكة. غالبًا ما يرغب الأشخاص في استخدام هذه الميزات الرائعة، ولكنهم غير قادرين على استخدامها. يتطلب البحث عن مدونة أو مقطع فيديو عشوائي لذلك الكثير من الوقت والصبر، ومع ذلك، فإن المعلومات التي تم الحصول عليها غير صحيحة. وفي الوقت الحالي، يستضيف برنامج VLC برنامج VLC لوثائق مستخدم Android على صفحة wiki ولا يقدّم وصفًا لهذه الميزات أو لا. بالإضافة إلى ذلك، تم إجراء آخر تعديل لصفحات wiki في مارس 2019. سيوفر المشروع الحالي وثائق مستخدم جديدة بتصميم حديث وسهولة استخدام أكبر لمنفذ Android.
الوضع الحالي
صفحات wiki قديمة تمامًا وتحتوي على معلومات أقل جدًا حول أحدث إصدار من VLC. كما أنه ليس من السهل التنقل فيها. لا يتوفّر خيار مرئي لقراءة المستندات بلغة أخرى غير الإنجليزية. ولا يحتوي على أوصاف الميزات على الإطلاق.
التحليل
في الوقت الحالي، أصبحت المستندات الحالية قديمة ويجب كتابتها بطريقة جديدة وباستخدام منصة وأدوات مختلفة.
-> يمتلك معظم مستخدمي Android معرفة فنية قليلة أو ليس لديهم معرفة تقنية. ولكن هناك أشخاص يحتاجون إلى مزيد من المعلومات الفنية حول ميزة ما. لا تُعد كتابة مستندين منفصلين لكل غرض من الأغراض المذكورة أعلاه والاحتفاظ بها فكرة جيدة. أو حتى في نفس التوثيق الذي يقسم ميزة على أساس تقني وغير فني يؤدي إلى ارتباك إضافي. ولأن معظم المستخدمين اعتادوا مرة أخرى على واجهة المستخدم التي يرونها أو الميزات التي يستخدمونها، فلن يكون من السهل على الجميع تحديد ما إذا كان هناك شيء تقني أو غير تقني. لذا نود تبسيط ذلك لهم.
-> سيحاول معظم المستخدمين الحصول على المعلومات من خلال هواتفهم الذكية نفسها والاستراحة من خلال سطح المكتب أو الأجهزة الأخرى. لذلك يجب أن تكون الوثائق قابلة للتكيف بسهولة مع كل حجم شاشة. ولن يخلق أي التباس بشأن التنقل.
-> لا تتوفر كل ميزة من ميزات إصدار سطح المكتب في منفذ android، وإذا كانت متاحة، فإنها لا تعمل بالطريقة نفسها في كلا المنفذين. وذلك لأنّ تطبيق سطح المكتب كان قيد التطوير منذ وقت طويل وقد وصل إلى نوع من حالة التشبع، وعلى عكس منفذ الهاتف المحمول جديد نسبيًا وما زال قيد التطوير. وبخلاف ذلك، على الرغم من أن الأجهزة الجوّالة في الوقت الحاضر أصبحت فعّالة للغاية، هناك قيود واضحة على نوع الميزات التي يمكننا دمجها في الغالب بسبب طلب المستخدم النهائي. إن وجود ميزة لا يستخدمها أحد يعد هدرًا لموارد التطوير. ولذلك لا يُنصح بتحويل كلا الوثيقتين على أساس الميزات.
بناءً على التحليل أعلاه، أقترح ما يلي. 1- في الوقت الحالي، تستخدم وثائق مستخدم سطح المكتب أداة إنشاء وثائق Sphinx ومظهر المستندات. سيساعدنا استخدام الأمر نفسه لمنفذ Android في الطرق التالية: -> دمج كلا المستندين بسهولة. -> مُحسن لجميع أحجام الشاشات. -> تجربة سلسة عند الانتقال إلى مستندات المستخدم في Android من خلال مستندات سطح المكتب
- فصل الفصول والأقسام والأقسام الفرعية وفقًا لموضعها النسبي في التطبيق. على سبيل المثال، - يمكنك العثور على وضع "الخلفية/نافذة ضمن النافذة" (PiP) ضمن "المزيد" -> "الإعدادات"-> "الفيديو"، وبالتالي ستظهر بنية الفصل
- المزيد
- |__الإعدادات
- | |__مكتبة الوسائط
- | |__Video -->وضع PIP/الخلفية/الخلفية
- : -> سيحسن هذا الأسلوب من سهولة الوصول إلى الجزء حيث سيكون بإمكان المستخدمين الانتقال إلى الجزء بسهولة حيث يحتاجون إلى المساعدة من خلال مقارنته بالموقع النسبي في التطبيق. بالنسبة إلى كل ميزة من الميزات، يمكننا فصل الأجزاء الفنية وغير الفنية. سنكتب أولاً وصفًا غير تقني سهل الاستخدام، ثم نسلّط الضوء على الأجزاء الفنية للميزة نفسها أو نسميها، إن وجدت، أسفلها مباشرة. قد يؤدي ذلك إلى بعض التكرار، ولكنه سيضمن تجربة سلسة بالنسبة إلى الأغلبية غير الفنية. سيساعد هذا أيضًا في المستقبل في المستقبل عن طريق زيادة قابلية الصيانة. نظرًا لأن التطبيق سيصل إلى حالة التشبع، من غير المحتمل أن تتغير واجهة المستخدم النسبية كثيرًا، ولذلك إذا تمت إضافة/إزالة ميزة جديدة، يمكننا ببساطة إعادة هيكلة القسم. في حال تغيير واجهة المستخدم بالكامل، يمكننا إعادة ترتيب الأقسام/الفصول أو إعادة هيكلة المستند بأكمله، وفي كلتا الحالتين نحتاج إلى تعديل المستند بأكمله لأنه يجب استبدال لقطة الشاشة لتطابق واجهة المستخدم الحالية. تتم استضافة عرض توضيحي عملي هنا : 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 على كل من المنصات المكتبية والأجهزة المحمولة لسنوات عديدة حتى الآن وأعرف المشكلات التي قد يواجهها المستخدم. من خلال الجمع بين كل معرفتي وخبرتي، يمكنني أن أؤكد لك أنّ هذا المحتوى رائع.