تحتوي هذه الصفحة على تفاصيل مشروع كتابة تقنيّة تم قبوله في موسم المستندات من Google.
ملخص المشروع
- المؤسسة المفتوحة المصدر:
- موسيقى موسيقية
- الكاتب التقني:
- سواتي ثاكر
- اسم المشروع:
- مراجعة مستندات "المستخدم النهائي" وتعديلها في Mautic
- مدة المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
انطباعاتي الأولى عند مراجعة المستندات الحالية:
في الوقت الحالي، الوثائق طويلة ومتكررة في الكثير من الأماكن وغير مكتملة ومضطربة، ما قد يجعل من الصعب على المستخدمين العثور على المعلومات التي يبحثون عنها.
بصفتي مستخدمًا للمرة الأولى، لم أتمكّن من فهم كيفية تناغم العناصر المختلفة من Mautic، مثل الحملات ومواد العرض والرسائل والفئات وما إلى ذلك، من أجل تلبية احتياجات النشاط التجاري. أنصحك بإدراج موضوع مفاهيمي عالي المستوى يصف كل عنصر Mautic في سطرَين أو ثلاثة أسطر. يمكن أن يرتبط هذا الموضوع بدوره بموضوعات المهام التفصيلية المختلفة لكل عنصر من هذه العناصر.
يمكن توسيع الدليل المساهم ليشمل المزيد من المعلومات، مثل كيفية فتح مشكلة وكيفية اقتراح محتوى أو أفكار جديدة والإبلاغ عن الأخطاء/المشاكل/الثغرات الأمنية وما إلى ذلك من خلال توفير روابط إلى المنتديات وقنوات Slack ومستودعات git. أيضًا، يجب توسيع دليل النمط لإضافة اصطلاحات مطبعية قياسية وإرشادات للصور والجداول وما إلى ذلك.
إضافةً إلى ذلك، هناك قدر كبير من المعلومات غير المكتملة في رسائل البريد الإلكتروني والحملات والمعلومات القديمة/القديمة التي تحتاج إلى تحديث.
المجال الذي أريد المساهمة فيه:
وأثناء استعراض المناقشات حول قنوات Slack حيث يتفاعل المستخدمون مباشرةً مع منتدى Mautic، أدركت أن الحملات والرسائل الإلكترونية من العناصر الأساسية في Mautic. وباستخدام Mautibox مع الإصدار 3، اختبرت المستندات في "الحملات" واكتشفت أنها تحتاج إلى تجديد مكثف. في ما يلي بعض المشاكل التي وجدتها بالإضافة إلى اقتراحي لكل منها:
- يمكن لمستخدم Mautic الاختيار من بين مجموعة متنوعة من الإجراءات والقرارات والشروط أثناء إنشاء حملة. المستندات غير متوفّرة للعديد من الإجراءات والقرارات، في حين لا تتوفّر تقريبًا أي مستندات لشروط الحملة. نحتاج إلى تحديد المعلومات الناقصة وإضافتها إلى مستند المستخدم النهائي.
- يمكن أن تكون الحملات بسيطة أو معقدة للغاية. لا تضيف المستندات الحالية قيمة كبيرة إلى المستخدمين الذين ينشئون الحملات للمرة الأولى. أقترح تحديد بعض حالات الاستخدام (سواء البسيطة والمعقدة) وإنشاء نماذج لسير العمل (إما في شكل برامج تعليمية تفصيلية، أو مواضيع ضمن دليل المستخدم النهائي أو فيديوهات تفصيلية) يمكن للمستخدمين الجدد الرجوع إليها قبل البدء في إنشاء حملاتهم الخاصة.
- تحتاج المعلومات إلى عرضها بطريقة أكثر تنظيمًا وتنظيمًا في هذا القسم. يجب اتباع النهج القائم على المهمة والمفهوم لزيادة سهولة الاستخدام. يمكن للمواضيع استخدام الجداول لتقديم معلومات حول الإجراءات والقرارات والشروط. يبدو أنّ الموضوع "استخدام مشغِّلات التاريخ" في غير محله بعض الشيء. ويمكن أن يتداخل ضمن "الشروط".
وبالإضافة إلى الحملات، اختبرتُ أيضًا مستندات الرسائل الإلكترونية في مقابل واجهة المستخدم. إليك ما أقترح عليه العمل عليه:
- يتوفّر المحتوى الديناميكي للرسائل الإلكترونية لنماذج الرسائل الإلكترونية المخصّصة للرموز المخصّصة (لكلّ من الرسائل الإلكترونية التي تخصّ "النماذج" و"شرائح الجمهور")، ولكن لا تتوفّر حاليًا أيّ مستندات لها. أضف تفاصيل حول وظيفة المحتوى الديناميكي وكيفية إعداده، إلى جانب بعض الأمثلة.
- يُرجى إضافة موضوع منفصل لرسائل "التتبّع" الإلكترونية. يمكن أن يتضمن هذا معلومات حول استخدام أدوات البريد الإلكتروني المتوفرة في لوحة البيانات وكيفية استخدامها لتتبع المقاييس والأنشطة المتعلقة بالبريد الإلكتروني. يمكنك أيضًا نقل معلومات تتبُّع الرسائل الإلكترونية إلى هنا.
- ولا توضح المستندات أن الردود على جهات الاتصال وإدارة الارتداد ورسالة البريد هي المالك، وهي إعدادات عمليات ضبط عامة يمكن ضبطها ضمن "إعدادات البريد الإلكتروني". يجب أن تأتي جميع إعدادات البريد الإلكتروني تحت موضوع شامل. بالإضافة إلى ذلك، لا يتم توثيق إعدادات إلغاء الاشتراك على الإطلاق في العديد من إعدادات البريد الإلكتروني الأخرى، مثل قواعد التكرار التلقائية. اذكر الإعدادات الإلزامية أو الاختيارية.
- من صفحة "إدارة الارتداد"، أزِل جميع المعلومات عن الردود التلقائية على الويب وضعها في موضوع منفصل لـ "الردود التلقائية على الويب". يمكننا بعد ذلك توفير رابط لهذا الموضوع من هنا.
إضافةً إلى ذلك: - يحتوي موضوع "لوحة البيانات" على معلومات غير مكتملة عن التطبيقات المصغّرة المتاحة. هذه المعلومات مهمة ويجب إضافتها لأنّها تساعد المستخدمين على تحليل موارد Mautic ومراقبتها.
يجب جلب الوثائق بأكملها لتحديد الثغرات. نحتاج إلى التجديد بهدف جعل المستند أكثر سهولة من قبل المستخدمين.
كيف أتوقع أن تكون معرفتي/خبرتي مفيدة لهذا المشروع؟
بعد العمل على مشاكل مختلفة في مستندات Mautic، بما في ذلك إضافة دعم لأحدث إصدار من Mautic 3.0 على مدار الشهر الماضي، تمكّنتُ من التعرّف على هيكل مستندات المستخدم النهائي وتحديد الفجوات في المستندات أيضًا. وقضيتُ بعض الوقت في البحث عن المستندات الخاصة بأدوات التسويق الآلي الأخرى ومقارنتها بمستندات المستخدمين النهائيين في Mautic لفهم كيفية سد هذه الثغرات في مستنداتنا. تعد معرفتي بلغة HTML والأدوات والعمليات مفتوحة المصدر ميزة إضافية. أتابع حاليًا دورة في أبحاث تجربة المستخدم ويمكنني تطبيق المبادئ لإنشاء وثائق أكثر تركيزًا على المستخدم. أيضًا، من خلال خبرتي في بنية المعلومات، ستتمكن من تنظيم المحتوى واقتراح أفكار لمواءمة وثائقنا مع أهداف المستخدم. علاوة على ذلك، لدي موهبة لتوسيع معرفتي بالنطاقات التقنية الجديدة. بفضل خبرتي السابقة في الكتابة الفنية التي تبلغ مدتها 10 سنوات، وتجربتي السابقة في GSOD في إكمال مشروع لمؤسسة في مجال تقني كان جديدًا تمامًا بالنسبة إليّ، أنا متأكد من أنني سأتمكن من تحقيق العدالة في مساهماتي في مستندات Mautic.