این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه ی پروژه
- سازمان منبع باز:
- مائوتیک
- نویسنده فنی:
- سواتی تاکر
- نام پروژه:
- اسناد کاربر نهایی را برای Mautic مرور و به روز کنید
- طول پروژه:
- طول استاندارد (3 ماه)
شرح پروژه
اولین برداشت من هنگام بررسی اسناد موجود:
در حال حاضر، اسناد طولانی، در بسیاری از مکان‌ها اضافی، ناقص و نامنظم هستند که ممکن است یافتن اطلاعات مورد نظر کاربران را دشوار کند.
به‌عنوان اولین کاربر، نمی‌توانم بفهمم که چگونه عناصر مختلف Mautic مانند کمپین‌ها، دارایی‌ها، پیام‌ها، دسته‌ها و غیره برای رفع یک نیاز تجاری با هم همخوانی دارند. من پیشنهاد می کنم یک موضوع مفهومی سطح بالا داشته باشید که هر عنصر Mautic را در 2-3 خط توصیف کند. این مبحث می تواند به نوبه خود به موضوعات مختلف وظایف مفصل برای هر یک از این عناصر پیوند دهد.
راهنمای کمک‌کننده را می‌توان با ارائه پیوندهایی به انجمن‌ها، کانال‌های شل، و مخازن git، به گونه‌ای گسترش داد که شامل اطلاعات بیشتری مانند نحوه باز کردن یک موضوع، نحوه پیشنهاد محتوا/ایده‌های جدید، گزارش اشکالات/مشکلات/آسیب‌پذیری‌های امنیتی و غیره باشد. همچنین، راهنمای سبک باید گسترش یابد تا قراردادهای تایپوگرافی استاندارد، دستورالعمل‌هایی برای تصاویر، جداول و غیره اضافه شود.
علاوه بر این، اطلاعات ناقص کمی در ایمیل‌ها، کمپین‌ها و اطلاعات قدیمی/منسوخ وجود دارد که نیاز به به‌روزرسانی دارند.
منطقه ای که می خواهم در آن مشارکت کنم:
در حین بررسی بحث‌ها در کانال‌های Slack که در آن کاربران مستقیماً با جامعه Mautic تعامل دارند، متوجه شدم که کمپین‌ها و ایمیل‌ها عناصر حیاتی Mautic هستند. با استفاده از Mautibox برای نسخه 3، من مستندات را در Campaigns آزمایش کردم و متوجه شدم که نیاز به بازسازی شدید دارد. در اینجا برخی از مسائلی که پیدا کردم و پیشنهاد من برای هر یک آمده است:
- یک کاربر Mautic می‌تواند در حین ساخت یک کمپین، از میان انواع اقدامات، تصمیم‌ها و شرایط انتخاب کند. اسناد برای بسیاری از اقدامات و تصمیمات وجود ندارد، در حالی که تقریباً هیچ سندی برای شرایط مبارزات انتخاباتی وجود ندارد. ما باید اطلاعات گمشده را شناسایی کرده و به سند کاربر نهایی اضافه کنیم.
- کمپین ها می توانند ساده یا بسیار پیچیده باشند. اسناد فعلی ارزش زیادی برای کاربرانی که برای اولین بار کمپین ایجاد می کنند، اضافه نمی کند. من پیشنهاد می‌کنم موارد استفاده (هم ساده و هم پیچیده) و ایجاد گردش‌های کاری نمونه (به‌صورت آموزش‌های گام به گام، یا موضوعاتی در راهنمای کاربر نهایی یا ویدیوهای پیش‌رو) که یک کاربر برای اولین بار می‌تواند قبل از شروع به ساخت کمپین های خود به آن مراجعه کنید.
- اطلاعات نیاز به ارائه به شکلی منظم و منظم در این بخش دارد. رویکرد مبتنی بر وظیفه و مفهوم باید برای افزایش قابلیت استفاده دنبال شود. موضوعات می توانند از جداول برای ارائه اطلاعات در مورد اقدامات، تصمیمات و شرایط استفاده کنند. موضوع "استفاده از محرک های تاریخ" کمی نابجا به نظر می رسد. می تواند تحت شرایط لانه کند.
علاوه بر کمپین‌ها، اسناد را برای ایمیل‌ها در برابر UI نیز آزمایش کردم. این چیزی است که من برای کار روی آن پیشنهاد می کنم:
- محتوای پویا برای ایمیل‌ها برای قالب‌های ایمیل کد سفارشی (هم برای ایمیل‌های الگو و هم برای ایمیل‌های بخش‌ها) در دسترس است، اما در حال حاضر، هیچ سندی برای آن وجود ندارد. جزئیات مربوط به آنچه محتوای پویا انجام می دهد و نحوه تنظیم آن را به همراه چند مثال اضافه کنید.
- یک موضوع جداگانه برای نظارت بر ایمیل ها اضافه کنید. این می تواند شامل اطلاعاتی در مورد استفاده از ویجت های ایمیل موجود در داشبورد و نحوه استفاده از آنها برای ردیابی معیارها و فعالیت های مربوط به ایمیل باشد. همچنین، اطلاعات مربوط به ردیابی ایمیل ها را به اینجا منتقل کنید.
- مستندات روشن نمی‌کند که پاسخ‌های تماس، مدیریت پرش، ایمیل‌کننده مالک است - تنظیمات پیکربندی جهانی هستند که می‌توانند در تنظیمات ایمیل پیکربندی شوند. تمام تنظیمات ایمیل باید تحت یک موضوع چتر قرار گیرند. همچنین، بسیاری از تنظیمات ایمیل دیگر مانند قوانین فرکانس پیش فرض، تنظیمات لغو اشتراک به هیچ وجه مستند نیستند. ذکر کنید کدام تنظیمات اجباری یا اختیاری هستند.
- از صفحه مدیریت Bounce، تمام اطلاعات مربوط به Webhooks را حذف کرده و در یک موضوع جداگانه برای Webhooks قرار دهید. سپس می توانیم پیوندی به آن موضوع از اینجا ارائه دهیم.
علاوه بر این: - موضوع داشبورد اطلاعات ناقصی در مورد ویجت های موجود دارد. این اطلاعات مهم است و باید اضافه شود زیرا به کاربران کمک می کند منابع Mautic خود را تجزیه و تحلیل و نظارت کنند.
برای شناسایی شکاف‌ها، باید کل مستندات را جمع آوری کرد. ما باید از نظر دسترسی بیشتر به سند توسط کاربران خود اصلاح کنیم.
چگونه انتظار دارم دانش/تجربه ام برای این پروژه مفید باشد؟
پس از کار بر روی مسائل مختلف در مستندات Mautic از جمله افزودن پشتیبانی برای آخرین نسخه Mautic 3.0 در یک ماه گذشته، توانستم با ساختار مستندات کاربر نهایی آشنا شوم و همچنین شکاف های موجود در اسناد را شناسایی کنم. من زمانی را صرف تحقیق در مورد اسناد سایر ابزارهای اتوماسیون بازاریابی و مقایسه آن با مستندات کاربر نهایی Mautic کرده‌ام تا بفهمم چگونه می‌توانیم این شکاف‌ها را در اسناد خود پر کنیم. آشنایی من با زبان HTML، ابزارهای منبع باز و فرآیندها یک مزیت است. من در حال حاضر دوره‌ای را در زمینه تحقیق تجربه کاربر دنبال می‌کنم و می‌توانم اصول را برای ایجاد اسنادی که بیشتر کاربر محور هستند به کار ببرم. همچنین، با تجربه‌ای که در معماری اطلاعات دارم، می‌توانم محتوا را سازماندهی کرده و ایده‌هایی را برای همراستایی اسناد خود با اهداف کاربر ارائه دهم. علاوه بر این، من در گسترش دانش خود در زمینه های فنی جدید مهارت دارم. با 10 سال تجربه نگارش فنی و تجربه قبلی GSOD من در تکمیل موفقیت آمیز یک پروژه برای یک سازمان در حوزه فنی که برای من کاملاً جدید بود، مطمئن هستم که می توانم عدالت را نسبت به مشارکت خود در مستندسازی Mautic رعایت کنم.