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