أنت هنا:

إمكانية الوصول إلى الوثائق

سؤال: كيف تتلاءم الوثائق مع مختلف المستخدمين؟

وصف المنتج

تعد إمكانية الوصول إلى الوثائق أمرًا بالغ الأهمية نظرًا للدور الذي تلعبه التوثيق في المشاريع مفتوحة المصدر. يتمتع مستخدمو التوثيق بقدرات مختلفة ، مما يتطلب تقديم الوثائق في تنسيقات مختلفة ليكون ممكناً بشكل متساوٍ لهؤلاء المستخدمين المختلفين. الهدف هو تعزيز التفاهم لأوسع جمهور من المساهمين في المشروع.

اهدافنا

تساعد هذه الأهداف في قياس ما إذا كانت وثائقك متاحة لجمهور عريض دون إنشاء أو إدامة ديون مصطنعة على شرائح معينة من الجماهير المقصودة بشكل غير متناسب.

  • قارئ شاشة إمكانية الوصول - يمكن الوصول إلى التوثيق وفقًا لمعيار خاص بقارئات الشاشة.
  • تعلم المرونة - التوثيق في متناول الأشخاص ذوي الأساليب المعرفية المختلفة والاختلافات الحسية والتنوع العصبي. 1.
  • المكفوفين أو ضعاف البصر - التوثيق متاح للأشخاص الذين يقرؤون النص بشكل أساسي. المخططات والصور هي أمثلة على أنواع الوثائق التي يتعذر الوصول إليها.

تطبيق

قد يؤدي استخدام المقاييس الصحية ونشرها إلى انتهاكات الخصوصية. قد تتعرض المنظمات للمخاطر. قد تتدفق هذه المخاطر من الامتثال للائحة العامة لحماية البيانات في الاتحاد الأوروبي ، أو مع قانون الولاية في الولايات المتحدة ، أو مع قوانين أخرى. قد تكون هناك أيضًا مخاطر تعاقدية ناتجة عن شروط الخدمة لموفري البيانات مثل GitHub و GitLab. يجب فحص استخدام المقاييس بحثًا عن المخاطر ومشكلات أخلاقيات البيانات المحتملة. لطفا أنظر وثيقة أخلاقيات البيانات CHAOSS للحصول على إرشادات إضافية.

ملاحظة: كن منتبهاً للجماهير المستهدفة للتوثيق. نظرًا للطيف الواسع من المشاريع والأشخاص الذين قد يساهمون ، يجب أن يتناول التوثيق المتطلبات المختلفة لجميع الجماهير.

استراتيجيات جمع البيانات

  • إستخدم أداة يقيّم مدى ملاءمة قارئ الشاشة. 5 6 لتحديد ما إذا كانت الوثائق مناسبة لقارئ الشاشة؟
  • المقابلة الشخصية الوافدون الجدد لمعرفة كيف يساعد التوثيق ، (أ) فهم عملية المساهمة ، و / أو ، (ب) المساعدة على إكمال المهام في المشروع. عينة أسئلة المقابلة:
    • ما هي تجربتك في استخدام الوثائق لفهم عملية المساهمة؟
    • ما هي خبرتك في استشارة الوثائق عندما يكون لديك سؤال حول القيام بالعمل في المشروع؟
    • هل كنت مرتاحًا للمصطلحات الفنية الموجودة في الوثائق؟
  • الدراسة الاستقصائية أعضاء المشروع

    • عنصر المصفوفة: عندما تحتاج إلى تحديد موقع معلومات حول عمليات أو سياسات أو إرشادات هذا المشروع ، أي مما يلي يصف تجربتك؟ 2
    • يمكن أن تكون صفوف المصفوفة:

      • الاتصالات القائمة البريدية
      • التواصل عبر الدردشة
      • أداء مراجعات التعليمات البرمجية
      • عملية الحصول على الكود مقبولة
      • القواعد السلوكية
      • إعداد الوافدين الجدد
      • الترخيص
      • علامة تجارية
      • إضافة Committers / مشرفين جدد
      • إصدارات المشروع
      • عملية التصويت
      • إجراءات التثبيت
      • تطوير الميزات
      • تكامل واجهة برمجة التطبيقات
      • أجنحة الاختبار
      • نظرة عامة على العمارة
      • دليل المستخدم
    • يمكن أن تكون أعمدة المصفوفة:
      • من السهل دائمًا العثور عليه
      • سهل الإيجاد
      • من الصعب العثور على
      • من الصعب جدا العثور عليها
    • الاختيار من متعدد: هل واجهت أي تحديات تتعلق بإمكانية الوصول إلى الوثائق عندما بدأت المشاركة في المشروع (على سبيل المثال ، حواجز اللغة ، وإمكانية اكتشاف الوثائق ، وهيكل التوثيق)؟ 2
    • خيارات الإجابة:
      • لا توجد تحديات
      • قليل من التحديات
      • عدة تحديات
      • العديد من التحديات
    • سؤال متابعة مفتوح إذا كانت الإجابة ليست "لا توجد تحديات": صف مثالاً على وقت مواجهة التحدي ، وكيف أثر التحدي عليك ، وكيف تغلبت على التحدي على الإطلاق.
    • سؤال مفتوح: ما هي الاقتراحات التي لديك لتحسين سياسات المشروع أو عملياته أو إرشاداته المتاحة للمساهمين الجدد؟ 2
  • ابحث عن تنظيم التركيبات المتعلقة بقابلية القراءة والقابلية للمسح مثل:
    • العناوين
    • كتل النص والتعليمات البرمجية
    • تعداد نقطي أو فقرات
    • المراسي
  • تقييم إمكانية البحث من خلال مراعاة:
    • ما مدى سهولة العثور على هذه الوثائق من قبل المستخدم؟
    • ما مدى سهولة العثور على المستخدم ما يحتاجه في الوثائق؟
    • هل المستند سهل التنقل باستخدام لوحة المفاتيح؟
  • قدم استبيانًا سريعًا سريعًا بسؤال واحد فقط لقراء الوثائق (على سبيل المثال ، الصفحة السفلية أو النافذة المنبثقة عند مغادرة صفحة التوثيق):
    • نعم / لا سؤال: هل كانت صفحة التوثيق هذه في متناولك؟
    • مقياس ليكرت [1-x]: ما مدى سهولة الوصول إلى هذه الوثائق بالنسبة لك؟
    • إجابة قصيرة: ما هو شعورك حيال إمكانية الوصول إلى الوثائق؟
  • تجول مع المستخدمين المستهدفين للوثائق. لاحظ كيف يتفاعلون ويستخدمون الوثائق وأين يتعثرون. يمكن أن تكون هذه جلسة مؤتمر عبر الفيديو حيث يشارك مستخدم الوثائق شاشته.
  • اطلب من مستخدمي الوثائق كتابة ملف سجل الاحتكاك ووصف المشكلات التي واجهوها مع التوثيق. هذا يعطي حالات استخدام ملموسة لمحرري الوثائق لفهم كيفية تحسين التوثيق لمستخدم معين.
  • ضع في اعتبارك ما إذا كان إصدارات مختلفة من الوثائق متاحة لجماهير مختلفة؟ على سبيل المثال ، نسخة خفيفة الوزن ونسخة مفصلة للغاية.

الموارد

  1. كسر الحواجز التي تحول دون مساهمة Kubernetes للأفراد المتشعبين العصبي
  2. استبيان مجتمع Apache Software Foundation 2020
  3. فريق الوصول جنوم
  4. إرشادات الوصول إلى محتوى ويب W3C
  5. قائمة أدوات تقييم ولوجية الويب W3C
  6. بعض الاختبارات السريعة لتقييم إمكانية الوصول إلى الويب
  7. المعرفة - مجموعة متخصصة في إمكانية الوصول
  8. أفكار حول مقاييس الوصول
  9. قائمة Paypal للمبادئ التوجيهية لإمكانية الوصول
  10. تصميم عالمي

المساهمين

تمت مراجعة هذا المقياس آخر مرة في 24 يوليو 2022 كجزء من عملية مراجعة المقاييس.

هل كان المقال مساعدا؟!
كراهية 0