تحتوي هذه الصفحة على تفاصيل مشروع كتابة تقنيّة تم قبوله في موسم المستندات من Google.
ملخص المشروع
- المؤسسة المفتوحة المصدر:
- HPX
- الكاتب التقني:
- رستوبو
- اسم المشروع:
- تعديل مستندات HPX الحالية وتبسيطها
- مدة المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
اقتراحي هو تعديل محتوى وثائق HPX الحالية وتبسيطه. اقتراحي يتعلّق بمشروع عادي (مدته ثلاثة أشهر) يركّز على مراجعة فصلَين من STE||دليل مجموعة الواقع المعزّز: ""نظام إصدار HPX وإطلاقه" (1) و"ضبط تطبيقات HPX" (2).
يتضمن الفصل الذي يتناول "نظام إصدار HPX وإطلاقه" العديد من الأخطاء النحوية، ويحتوي أيضًا على لغة مربكة ولغة غير متسقة مكتوبة بمصطلحات غير متسقة، مثل"CMake" (لغة C). بالإضافة إلى ذلك، يتضمن الكتاب معلومات متكررة أخطط لإعادة ترتيبها ودمجها واقتطاعها حسب الحاجة. ورغم أن الفصل المتعلق بـ "تهيئة تطبيقات HPX" يتضمن أيضًا بعض الأخطاء النحوية التي يجب معالجتها، فإن أكثر ما يهمني في هذا الفصل هو مدى توافقه مع المستخدم. يحتوي الفصل على ثلاث مشكلات رئيسية في التصميم أخطط لمعالجتها:
يتم دفن بعض العناوين داخل النص، مما يجعل من الصعب تصفُّح الفصل. في الوقت الحالي، سيحتاج المستخدم إلى قراءة الدليل بعناية لفهم الغرض من كل جدول. ليست هذه هي الطريقة التي يتفاعل بها معظم المستخدمين مع كتيبات التعليمات، خاصة إذا كانوا قد قرأوا المحتوى من قبل. بدلاً من ذلك، أخطط للتأكد من أن كل جدول يحتوي على عنوان واضح ومميز، والذي يمكن رؤيته بسهولة إذا قام المستخدم بالتمرير خلال النص.
عند إدراج خصائص مختلفة ضمن عنوان معين، لا تتبع الخصائص ترتيبًا منطقيًا. في حين يتم تجميع المواقع معًا ضمن موضوع مشترك، لا توجد مجموعات فرعية، مما يجعل المعلومات تبدو مبعثرة. على سبيل المثال، قد يصادف المستخدم عدة خصائص تتعامل مع المنطقة المحلية، بعضها يتعامل مع موضوع آخر، ثم خصائص أخرى تتعامل مع المنطقة المحلية. هذا النقص في الهيكل الداخلي تحت العناوين يجعل من الصعب تحديد جميع المعلومات حول موضوع فرعي معين. لذلك، أخطط لإعادة تنظيم العديد من المخططات لتجميع المعلومات المتشابهة بشكل أكثر وضوحًا تحت كل عنوان.
يتعين على المستخدمين التنقل ذهابًا وإيابًا بين الأقسام (أو فتح الدليل في علامتي تبويب منفصلتين) لفهم تعليمات معينة تمامًا. هناك نقاط حيث يوجّه الفصل المستخدم إلى جملة واحدة داخل قسم سابق بطريقة تجبر القارئ على التمرير لأعلى أو اتباع رابط تشعّبي لفهم التعليمات الدقيقة، حيث يستخدم الدليل لغة غامضة مثل "يتم إعداد هذه الخطوة بعد الخطوة 11" في القسم السابق. في حين أن هذه الطريقة تقضي على التكرار، إلا أنها تجعل من الصعب فهم التعليمات، حيث إنها مهام يجب إجراؤها بترتيب معين. بدلاً من ذلك، أقترح تضمين صياغة أكثر تحديدًا حتى لا يضطر المستخدمون إلى مقاطعة عملية القراءة عن طريق التبديل بين الأقسام أو المستندات.
إذا أكملت هذه الأقسام قبل انتهاء المخطط الزمني العادي، أرغب أيضًا في تنظيف صفحة "لماذا HPX؟" (3) ضمن مجموعة STE||وثائق المستخدم لمجموعة الواقع المعزّز. تحتوي هذه الصفحة على محتوى تمهيدي متكرر، آمل أن يدمج ذلك المحتوى ويحتوي على تناقضات في الكتابة بالأحرف اللاتينية الكبيرة (خاصة المصطلحات الاصطلاحية) والصوت، ما يضفي طابعًا غير موحّد. سيكون هدفي هو إنشاء مقدمة أكثر توحيدًا واتساقًا لعمل مجموعة STE||AR.