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