این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه ی پروژه
- سازمان متن باز:
- مائوتیک
- نویسنده فنی:
- کلوین را مورد لطف قرار دهید
- نام پروژه:
- دانش محور
- طول پروژه:
- طول استاندارد (3 ماه)
شرح پروژه
خلاصه
پایگاه دانش یک مخزن متمرکز است که در آن اطلاعات ذخیره، سازماندهی و سپس به اشتراک گذاشته می شود. هنگامی که به صورت خارجی مورد استفاده قرار می گیرد، پایگاه دانش جایی است که کاربران می توانند برای یادگیری هر چیزی که در مورد محصولات یا خدمات، سازمان و صنعت یک شرکت نیاز دارند، مراجعه کنند. از سوی دیگر، پایگاه دانش داخلی معمولاً به عنوان راهی برای اجازه دادن به جامعه/کاربران برای همکاری و توزیع تمام دانش و اطلاعات شرکت در داخل استفاده می‌شود. در حالی که محتوای پایگاه‌های دانشی خاص بر اساس عوامل متعددی متفاوت است، بیشتر آنها معمولاً شامل اطلاعاتی در مورد نحوه شروع استفاده از محصولات خاص، استفاده بیشتر از ویژگی‌های پیشرفته و غلبه بر مشکلات یا مسائل رایج است. مزیت اصلی ایجاد و ارائه یک پایگاه دانش به مخاطبان شما این است که شما را قادر می سازد اطلاعات عمیق، فوری، درخواستی و پاسخ هایی را به مخاطبان/کاربران/جامعه خود بدون نیاز به انجام آن به صورت جداگانه ارائه دهید.
Mautic Knowledgebase یک مخزن مرکزی برای آموزش ها، راهنماهای نحوه انجام، و بهترین روش ها در مورد موضوعات مرتبط با Mautic است - چه به طور مستقیم (مثلاً نحوه انجام کارها در Mautic) یا غیر مستقیم (مثلاً استراتژی های بازاریابی عمومی تر).
در زمان نگارش این مقاله، پایگاه دانش Mautic کاملاً جدید و ناقص است و جامعه Mautic می‌خواهد از این پروژه برای بهبود روش خود در ارائه اطلاعات عمیق و درخواستی به مستندات کاربر استفاده کند تا کاربران نهایی را قادر به داشتن یک تجربه یکپارچه هنگام استفاده از Mautic. گذر از پایگاه دانش Mautic کاملاً آموزنده بود، اما به آموزش های به روز و راهنماهای چگونگی ایجاد موارد جدید و همچنین مطابقت با نسخه Mautic 3x نیاز داشت.
اولین برداشت های من هنگام بررسی اسناد موجود در حال حاضر، پایگاه دانش Mautic https://kb.mautic.org/ در دسترس است. برخی از آموزش‌ها و راهنماها و موضوعات بهترین روش‌ها در مستندات به‌روز نیستند و پراکنده یا ناقص هستند و همچنین اطلاعات مربوط به نسخه فعلی mautic را پوشش نمی‌دهند.
چرا بهبود پیشنهادی شما نسبت به حوزه فعلی/منطقه ای است که من دوست دارم در آن مشارکت کنم؟ بهبود پیشنهادی بهبود و تضمین کارایی، ثبات و آرامش خاطر برای هر کاربر نهایی خواهد بود. این شامل آموزش های مکتوب و راهنماهای نحوه انجام و بهترین شیوه ها و تصاویر مرتبط با آن، شامل دستورالعمل ها و توضیحاتی در مورد نحوه استفاده از هر ویژگی mautic، به روز، آسان برای پیمایش، و قابل درک است.
تحلیل و بررسی
پایگاه دانش Mautic در CMS فایل مسطح Grav و موضوع KLB4 نوشته شده است. من در مورد راه های بهبود مستندات پایگاه دانش بسیار تحقیق کردم
اهداف پروژه
- پایگاه دانش را مرور کنید.
- آموزش ها و راهنماها را متناسب با نسخه Mautic 3x به روز کنید.
- منابعی را برای پایگاه دانش جدید Mautic Community ایجاد کنید
- یک سری آموزش و راهنما بنویسید که به کاربران Mautic کمک می کند تا در راه اندازی، پیکربندی و استفاده از برنامه موثرتر باشند.
- آموزش ویدیویی را متناسب با نسخه Mautic 3x به روز کنید.
- تصاویر و اطلاعات منسوخ را حذف کنید.
- پایگاه دانش را بازنویسی کنید تا درک آن آسان تر شود.
- از اجرای صحیح راهنمای سبک/الگوی مستندات پایگاه دانش اطمینان حاصل کنید
جدول زمانی
قبل از 1 آگوست
- به کمک به سازمان ادامه دهید.
- با مستندات پایگاه دانش و نسخه فعلی Mautic بیشتر آشنا شوید.
- تکنیک های جدید و مهارت های نوشتاری فنی را بیاموزید که در اجرای پروژه مفید خواهد بود.
پیوند جامعه (1 اوت - 1 سپتامبر)
- راه اندازی یک کانال ارتباطی و زمان (به دلیل اختلاف زمانی)
- اهدافم را اصلاح کنم و انتظاراتم را از هر دو طرف مشخص کنم
- درباره جامعه و محصول بیشتر بدانید
- بحث در مورد ساختار اسناد پیشنهادی با مربیان و سایر اعضای سازمان.
- ویژگی های پیشنهادی و سایر تغییراتی که باید در اسناد موجود انجام شود را نهایی کنید.
دوره مستندسازی
- هفته 1 (2 سپتامبر - 22 نوامبر)
- در طول این دوره‌ها، من مستقیماً با مربیانم کار می‌کنم تا:
- پایگاه دانش را مرور کنید.
- آموزش ها و راهنماها را متناسب با نسخه Mautic 3x به روز کنید.
- منابعی را برای پایگاه دانش جدید Mautic Community ایجاد کنید
- یک سری آموزش و راهنما بنویسید که به کاربران Mautic کمک می کند تا در راه اندازی، پیکربندی و استفاده از برنامه موثرتر باشند.
- آموزش ویدیویی را متناسب با نسخه Mautic 3x به روز کنید.
- تصاویر و اطلاعات منسوخ را حذف کنید.
- پایگاه دانش را بازنویسی کنید تا درک آن آسان تر شود.
- از اجرای صحیح راهنمای سبک/الگوی مستندات پایگاه دانش اطمینان حاصل کنید.
- با در نظر گرفتن آهنگ انتشار، زیرا تیم توسعه دهنده مشغول انتشار ویژگی های جزئی است
ارزیابی پروژه (25 تا 29 نوامبر 2019)
- گزارش پروژه و ارزیابی توسط مربیانم را ارسال کنید
- گزارشی از تجربه من به عنوان یک شرکت کننده در Season of Docs بنویسید و ارسال کنید.