تحتوي هذه الصفحة على تفاصيل مشروع كتابة فني مقبول ضمن "موسم المستندات" من 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 أشهر)، حيث أقبل فقط العديد من السلاسل للمراجعة قدر الإمكان خلال هذا الإطار الزمني.
نظرًا لأنني أعمل بالفعل بدوام كامل، فلن أتمكن من العمل إلا جزء من اليوم في هذا المشروع. أنا منفتح على إمكانية مشروع أطول إذا كنت تعتقد أن ساعات العمل المخفَّضة سيحتاج إليها.