تحتوي هذه الصفحة على تفاصيل مشروع كتابة تقنيّة تم قبوله في موسم المستندات من Google.
ملخص المشروع
- المؤسسة المفتوحة المصدر:
- فتح Collective
- الكاتب التقني:
- Anna e só
- اسم المشروع:
- تحسين مستندات المساعدة العامة
- مدة المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
الانطباعات الأولى غالبًا ما تصادف صفحات مستندات تحتوي على تعليمات بدون استخدام الوسائط (الفيديوهات وملفات GIF والصور) بينما تتضمّن الأقسام الأخرى ضمن الفصل نفسه إدخالات أكثر اكتمالاً. على سبيل المثال، يتكوّن القسم Edit Collective من تعليمات فقط، بينما يتضمّن القسم Add Fiscal Host (إضافة المضيف المالي) الوسائط الداعمة.
في الصفحات التي تصفحتها، لا يتم وصف أي وسائط باستخدام سمة النص البديل. يؤدي عدم توفُّر أوصاف الصور إلى عرقلة الفهم الكامل للمستندات التي يمكن لمستخدمي برامج قراءة الشاشة والأشخاص الذين يستخدمون اتصالات الإنترنت الأبطأ حيث يتعذّر تحميل أي وسائط.
تدمج بعض أقسام الوثائق الأسئلة الشائعة والتعليمات المباشرة للتنقل في واجهة المستخدم، مثل تغيير المضيف المالي. نظرًا لعدم وجود جدول محتويات في واجهة الوثائق، فإن المستخدم الذي يدرك عواقب التغيير في سجلات التسجيل ويريد فقط تعليمات موضوعية يمكنه اعتبار الوثائق مطوّلة وذاتية للغاية.
على الرغم من اتّساق لغة الوثائق الفنية إلى حدّ كبير، فإنّ مستندات دليل الأسلوب المتاحة للجميع تتضمّن معلومات قليلة جدًا عن كيفية كتابة الوثائق. بما أنّ صفحة المساهمة تشير إلى المساهمات في الوثائق الفنية، سيستفيد كلٌّ من منتدى 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]: تم التخطيط للرحلة قبل تقديم طلب الانضمام إلى "موسم المستندات".
المُخرَجات النهائية - عشرة تقارير عامة حول الأنشطة المُنفَّذة - دليل تنسيق عام يمكن لكل من المساهمِين الخارجيِين في Open Collective والمساهمين الخارجيين استخدامه - صفحات وثائق مستخدم مجدَّدة