تحتوي هذه الصفحة على تفاصيل مشروع كتابة فنية تم قبوله في "موسم مستندات Google".
ملخص المشروع
- مؤسسة مفتوحة المصدر:
- Open Collective
- الكاتب الفني:
- Anna e só
- اسم المشروع:
- تحسين مستندات المساعدة العامة
- مدة المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
الانطباع الأول من الشائع العثور على صفحات مستندات تحتوي على تعليمات بدون وسائط داعمة (فيديوهات أو صور GIF أو صور)، في حين تحتوي الأقسام الأخرى ضمن الفصل نفسه على إدخالات أكثر اكتمالاً. على سبيل المثال، تتألف صفحة تعديل المجموعة من تعليمات فقط، في حين تتضمّن صفحة إضافة مضيف مالي وسائط داعمة.
في الصفحات التي تصفّحتُها، لم يتم وصف أيّ وسائط باستخدام سمة النص البديل. يمنع عدم توفّر أوصاف للصور فهم المستندات بالكامل من قِبل مستخدمي برامج قراءة الشاشة والمستخدمين الذين لديهم اتصالات إنترنت بطيئة قد يتعذّر فيها تحميل أي وسائط.
تدمج بعض أقسام المستندات الأسئلة الشائعة والتعليمات المباشرة للتنقّل في واجهة المستخدم، مثل تغيير المضيف المالي. نظرًا لعدم وجود جدول محتويات في واجهة التوثيق، فإن المستخدم الذي يدرك عواقب أي تغيير في سجلات التسجيل ويريد فقط الحصول على إرشادات موضوعية قد يعتبر أن الوثائق مطوّلة وعرضية للغاية.
على الرغم من أنّ لغة المستندات التقنية متسقة إلى حدّ كبير، لا يوثّق دليل الأسلوب المتاح للجميع طريقة كتابة الوثائق. بما أنّ صفحة المساهمة تشير إلى المساهمات في المستندات الفنية، سيستفيد كل من Open Collective والمساهمين المحتملين من إرشادات أكثر شمولاً.
الاقتراح أقترح مراجعة صفحات مساعدة المستخدمين، وإعادة التفكير في طريقة عرضها وبنيتها الحالية.
المنهجية والجدول الزمني أريد تحسين وثائق Open Collective من خلال العمل جنبًا إلى جنب مع المنتدى للترويج لدورات الملاحظات المستمرة ذات المدة المختلفة.
فترة التعرّف على المنتدى (من 1 آب (أغسطس) إلى 1 أيلول (سبتمبر) 2019): التعرّف على منتدى Open Collective إجراء مقابلات مع أعضاء نشطين من المشاريع البارزة والمشاريع التي بدأت حديثًا، وطرح أسئلة عليهم حول الحالة الحالية للوثائق (التقرير رقم 1) تدوين ملاحظات حول جميع الأنظمة الداخلية المستخدمة لتتبع الاستعلامات والمشكلات وعملية توثيقها في Open Collective Docs (التقرير رقم 2). تقييم المشاكل الكامنة في الإصدار الحالي من المستندات وإعداد خطة لحلّها (التقرير رقم 3)
من 2 إلى 6 أيلول (سبتمبر): الدورة الأولى من الملاحظات والتعديلات، مع أخذ كل التعليقات والاقتراحات التي قدّمها المنتدى خلال فترة التفاعل مع الجمهور في الاعتبار هل خطتنا جاهزة للتنفيذ؟ هل هناك أي شيء تحتاج إلى تغيير بشأنه؟ (التقرير رقم 4)
من 9 إلى 20 أيلول (سبتمبر): تطوير دليل إثبات المفهوم باستخدام الفصل الأقل كثافة في المستندات مسودة دليل أسلوب علني (التقرير رقم 5)
من 23 إلى 25 أيلول (سبتمبر): إرسال إثبات المفهوم للتقييم (مجموعة مغلقة)
من 26 إلى 27 أيلول (سبتمبر): هل يحتاج دليل إثبات الفكرة إلى أي تعديلات قبل نشره؟ هل نحتاج إلى مزيد من الوقت؟ يُرجى تعديل القيمة وفقًا لذلك. (التقرير رقم 6)
30 أيلول (سبتمبر) - 9 تشرين الأول (أكتوبر): إطلاق الإصدار التجريبي من الميزة الدورة الثانية من الملاحظات (المجموعة العامة)
من 10 إلى 15 تشرين الأول (أكتوبر): دورة التقييم النهائي وإثبات المبدأ والتعديل (التقرير رقم 7)
من 16 إلى 20 تشرين الأول (أكتوبر): استراحة قصيرة من الأنشطة [1].
21 تشرين الأول (أكتوبر) - 23 تشرين الثاني (نوفمبر): دليل الأسلوب العام هو نهائي (التقرير رقم 8). تطبيق جميع التعليمات الواردة في دليل الأنماط على جميع صفحات مستندات المستخدمين (التقرير رقم 9) تقرير يُقيّم جميع الأنشطة التي تمّ إجراؤها ويقدّم مزيدًا من الاقتراحات للمنتدى (التقرير رقم 10)
يمكن تمديد مدة المشروع عند الطلب.
[1]: الرحلة التي تم التخطيط لها قبل تطبيق Season of Docs.
المُخرَجات النهائية - عشرة تقارير عامة عن الأنشطة التي تم تنفيذها - دليل أسلوب عام يمكن استخدامه لكل من Open Collective والمساهمين الخارجيين - صفحات وثائق المستخدم تم تجديدها