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