تحتوي هذه الصفحة على تفاصيل مشروع كتابة تقنيّة تم قبوله في موسم المستندات من Google.
ملخص المشروع
- المؤسسة المفتوحة المصدر:
- المسألة القانونية
- الكاتب التقني:
- @anindita_basu
- اسم المشروع:
- مراجعة النص داخل المنتج وتحسينه
- مدة المشروع:
- الجري الطويل (5 أشهر)
وصف المشروع
انضممت إلى قناة Slack وطرحت بعض الأسئلة على "إريك". استنادًا إلى
رده (شكرًا لك، إريك!)، أقترح التعامل مع هذا المشروع
على النحو التالي:
تصنيف السلاسل
سأبدأ بتحديد السلاسل (https://github.com/mattermost/mattermost-webapp/blob/master/i18n/en.json) هي سلاسل وحدة تحكّم النظام، وأيّ منها يتوجّه إلى المستخدم. أقترح أخذ السلاسل التي تواجه المستخدم للمراجعة في البداية.
إنشاء دليل أسلوب للسلاسل
أريد تحديد نمط الكتابة بالأحرف الكبيرة والطول واستخدام الكلمات للسلاسل المستخدمة في عناصر القائمة وأزرار الإجراءات والتسميات والعناوين والتلميحات والأخطاء والتحذيرات وعمليات التحقق من الصحة والإشعارات والتأكيدات (يمكنك الاطلاع على مثال للقطة شاشة لدليل الأنماط على https://github.com/AninditaBasu/AninditaBasu.github.io/blob/master/gsod/Capture7.PNG). أود أيضًا إنشاء بعض الإرشادات حول استخدام الرموز المميزة (العناصر النائبة) في السلاسل، خاصة السلاسل المركبة.
أهدف إلى إبقاء هذا الإرشادات في صفحة واحدة من ورقة بحجم A4، أقصر إن أمكن. الهدف من ذلك هو أن المطورين الذين يكتبون هذه السلاسل بالفعل يجب أن يجدوا الإرشادات سريعة وسهلة الاستخدام، بالإضافة إلى أنه عند اتباعها، سيظهر نص واجهة المستخدم الاتساق عبر جميع الشاشات.
أقترح القيام بذلك لسببين: (أ) بحيث يكون هناك تناسق في مادة النص من حيث القواعد النحوية والأسلوب (ب) بحيث تكون هناك مجموعة من التعليمات التي يمكن لأي شخص الرجوع إليها بسرعة عند كتابة نص واجهة المستخدم حتى بعد انتهاء GSoD
مراجعة النص وتحسينه
بناءً على دليل النمط الذي تم إنشاؤه في رقم 2، سأعدّل السلاسل وأنشئ طلبات سحب في GitHub.
=============
المدة
لا أعرف حتى الآن عدد السلاسل التي هي سلاسل مواجهة للمستخدم (وهو ما أقترح مناقشته للمراجعة في هذا المشروع). أتوقّع أنّ إنشاء دليل التنسيق سيستغرق حوالي 3 أسابيع (من المسودة إلى الموافقة)، ويمكن إتمام هذا العمل في الوقت نفسه مع تصنيف السلاسل كسلاسل نظام أو واجهة المستخدم. أقترح البدء بافتراض أن المشروع سيكون مشروعًا بطول قياسي (3 أشهر)، حيث أتناول فقط العديد من السلاسل للمراجعة قدر الإمكان خلال هذا الإطار الزمني.
نظرًا لأنني أعمل بدوام كامل بالفعل، فلن أتمكن من العمل إلا في جزء من اليوم في هذا المشروع. أنا منفتح على إمكانية مشروع أطول إذا كنت تعتقد أن ساعات العمل المخفضة ستحتاج إليه.