User Documentation در این آموزش یاد می گیرید که چگونه یک آموزش بسازید.
آموزش درسی است که شما را از طریق مجموعه ای از مراحل عملی راهنمایی می کند. این یک تجربه یادگیری را با انجام دادن چیزی ارائه می دهد. این بهترین راه برای آشنایی با موضوعی است که هنوز با آن آشنا نیستید. آموزش ها در هر مستنداتی حیاتی هستند: آن ها تازه واردان را راهنمایی می کنند، اولین قدم ها را هدایت می کنند، ویترین هستند، تجربه ای خوب و آسان از یک موضوع ارائه می دهند. یکی از "ترفندها" برای رسیدن به این هدف، حذف هر چیزی است که می تواند در فرایند یادگیری حواس پرتی ایجاد کند. برای مثال:
- راه های جایگزین برای انجام کاری یا راه هایی برای انجام کاری بسیار خاص.
- مرجع کامل همه گزینه ها و توضیح فنی ساختار آن.
- توضیحات مفصل و پیشینه های تاریخی.
آن اطلاعات اضافی بهتر است به صورت جداگانه ارائه شوند. تا جای ممکن از ترکیب آن ها با آموزش خودداری کنید، زیرا تنها آموزش را مبهم می کند. این اصل اصلی چارچوب Diátaxis است، روشی نظام مند برای بهبود مستندات. اطلاعات اضافی ذکر شده در بالا را در راهنماهای نحوه انجام کار، مراجع و توضیحات مربوطه قرار دهید. در راهنماهای نحوه انجام کار می توانید به سرعت بیابید که چگونه کاری خاص را انجام دهید. در مراجع می توانید نحوه کار چیزها، گزینه های آن ها و محل یافتن اطلاعات بیشتر را جستجو کنید. با توضیحات می توانید درک خود از موضوع را عمیق تر کنید.
اگرچه یک آموزش مقدمه ای بر یک موضوع ارائه می دهد، اما منحصراً برای مبتدیان نیست. همچنین می تواند مقدمه ای بر یک موضوع پیشرفته باشد! در ابتدای آموزش خود روشن کنید که چه دانش یا مهارتی برای انجام آموزش لازم است.
اگر به کسی یاد می دهید چگونه آشپزی کند، باید چیزهایی مانند تکنیک های برش، نحوه استفاده از فر و سایر موارد اولیه آشپزخانه را توضیح دهید. با یک دستور پخت ساده شروع می کنید، ترجیحاً چیزی که به راحتی نتیجه ای خوب به دست می دهد. آن نتیجه نهایی خودش هدف اصلی نیست: شما می خواهید مهارت هایی را آموزش دهید. این همان کاری است که یک آموزش انجام می دهد. کسی که بلد است آشپزی کند و می خواهد چیزی خاص درست کند، به چنین آموزشی نیاز ندارد، بلکه به یک دستور پخت نیاز دارد. دستور پخت ها راهنمای نحوه انجام کار آشپزی هستند.
مرحله به مرحله
برای ایجاد یک آموزش:
- اطلاعات مربوط به موضوع را جمع آوری کنید. مستندات موجود، ویدیوها و غیره. مواردی را که گیج کننده بوده یا درک آن ها زمان برده است یادداشت کنید. آیا سوالی درباره این موضوع در انجمن وجود دارد؟
- چه مفاهیمی درگیر هستند؟ کشیدن یک نمودار کوچک می تواند کمک کننده باشد. سعی نکنید کامل باشید، بلکه مشخص کنید چه چیزی برای این آموزش مهم است و چه چیزی نیست.
- آیا دانش یا مهارت خاصی لازم است که در آموزش خود آموزش دهید؟
- مثالی ایجاد کنید که بتوانید تمام مفاهیم و مهارت هایی را که می خواهید در آموزش منتقل کنید در آن استفاده نمایید. مثال را تا حد امکان ساده کنید.
- مراحلی را برای رسیدن به نتیجه نهایی تعریف و بنویسید. هر مرحله باید توسط دانش آموز شما قابل بازتولید باشد.
- تمام توضیحات، مراجع، جایگزین ها و موارد خاص را فیلتر کرده و در مطالب جداگانه ای قرار دهید.
- یک مقدمه بنویسید. در این آموزش چه چیزی خواهید آموخت؟ به هر پیش نیاز لازم برای انجام این آموزش اشاره کنید.
- خلاصه را بنویسید. چه چیزی یاد گرفتیم؟ همچنین می توانید به مراحل بعدی برای یادگیری بیشتر اشاره کنید.
- تصاویر گرفته شده از صفحه با حاشیه نویسی برای نشان دادن اقداماتی که باید انجام شود اضافه کنید. نکته: از اعداد در تصویر صفحه استفاده کنید و توضیحات را در متن بیاورید. این کار استفاده مجدد از تصویر صفحه شما در ترجمه ها را آسان تر کرده و تلاش لازم برای تولید تصاویر صفحه مخصوص هر زبان را به حداقل می رساند.
- نمودارهایی برای توضیح ساختارها، روابط و فرآیندها اضافه کنید.
- مطالب همراه شامل توضیحات، مراجع و راهنماهای نحوه انجام کار را اضافه کنید.
- تمام مطالب یک موضوع را زیر یک مطلب کلی قرار دهید که توضیح دهد چه چیزی چیست، چگونه به هم مرتبط هستند و از کجا باید شروع کرد.
مثال: ایجاد و انتشار یک مطلب در جوملا
به عنوان مثال، بیایید آموزشی بسازیم درباره چگونگی ایجاد و انتشار یک مطلب زیر یک آیتم منو در جوملا.
جمع آوری اطلاعات
در دفترچه راهنمای کاربر ما، مطالب مرتبط را زیر "شروع به کار"، "مطالب" و "منوها" خواهید یافت. اغلب هنگام شروع کار با جوملا گیج کننده است که پس از ایجاد یک مطلب، حتی اگر آن را "منتشر شده" علامت زده باشید، آن را نمی بینید. برای دیدن مطلب، باید پیوندی به آن وجود داشته باشد. چندین روش برای ایجاد چنین پیوندی وجود دارد (مانند یک آیتم منو یا طرح بندی وبلاگ مجموعه یا با قرار دادن آن در طرح بندی وبلاگ صفحه اصلی با علامت زدن مطلب به عنوان ویژه یا پیوند دادن از مطلب دیگر)، اما اکنون روی در دسترس قرار دادن مطلب از طریق یک آیتم منو تمرکز می کنیم.
مفاهیم و مهارت ها
ما 'محتوا'، 'مطلب'، 'منو' و 'آیتم منو' داریم. باید این اصطلاحات را روشن کنیم. نشان می دهیم این موارد را کجا در منوی مدیریت پیدا کنید. در این آموزش 'مجموعه ها' یا 'ویژه' را کنار می گذاریم.
پیش نیازها
شما باید به بخش مدیریت یک سایت جوملای فعال دسترسی داشته باشید و بدانید چگونه وارد شوید.
هدف
هدف ما این است که یاد بگیریم چگونه یک مطلب جدید جوملا و یک آیتم منوی جدید ایجاد کنیم که مطلب خود را زیر آن قرار دهیم.
مراحل
برای رسیدن به هدف خود از مراحل زیر استفاده کنید:
الف. ایجاد یک مطلب
- وارد پنل مدیریت جوملای خود شوید.
- ابتدا مطلب را ایجاد می کنیم. به منوی "محتوا" در سمت چپ بروید و "مطالب" را انتخاب کنید.
- برای ایجاد یک مطلب جدید روی "جدید" کلیک کنید.
- عنوان و محتوای مطلب خود را وارد کنید.
- برای ذخیره مطلب خود روی "ذخیره و بستن" کلیک کنید.
ب. ایجاد یک آیتم منو که به مطلب پیوند دارد
برای نمایش مطلب در سایت، یک آیتم منو ایجاد می کنیم که به مطلب پیوند دارد. به منوی "منوها" در سمت چپ بروید و "منوی اصلی" را انتخاب کنید.
- درست مثل یک مطلب، برای ایجاد یک آیتم منوی جدید روی "جدید" کلیک کنید.
- عنوانی برای آیتم منوی خود وارد کنید. این عنوانی است که در منو نمایش داده می شود. لازم نیست با عنوان مطلب یکسان باشد. معمولاً کوتاه تر از عنوان یک مطلب است تا بهتر در منو جا بگیرد.
- یک نوع آیتم منو را انتخاب کنید: زیر "مطالب" گزینه "مطلب تکی" را انتخاب کنید.
- مطلب را انتخاب کنید: مطلبی را که به تازگی ساختیم انتخاب کنید.
- به سایت بروید و صفحه را تازه سازی کنید. تبریک می گویم: اکنون می توانید روی آیتم منو کلیک کنید تا مطلب خود را ببینید.
مقدمه
مقدمه را بنویسید: در این آموزش چه چیزی یاد خواهید گرفت و چه پیش نیازهایی لازم است.
فیلتر کردن اطلاعات اضافی
آیا می توانیم چیزی از آنچه تا کنون نوشته شده را حذف کنیم؟ خب، در مرحله 2 ایجاد آیتم منو اشاره کردم که عنوان آیتم منو لازم نیست با عنوان مطلب یکسان باشد. آیا این یک افزوده ضروری برای این آموزش است؟ اگر نه، بهتر است فعلاً آن را حذف کنیم. اما این نکته سرنخی برای یک مطلب تخصصی تر درباره عناوین مطالب و عناوین منو و زمان نمایش آنها می دهد، که شامل گزینه های کلی مطلب، تنظیمات فردی مطلب زیر برگه گزینه ها، تنظیمات آیتم منو زیر برگه گزینه های آیتم منو و موارد دیگر می شود. همچنین خوب است یک مطلب از نوع مرجع درباره نحوه کارکرد مشترک مطالب، مجموعه ها و آیتم های منو ایجاد شود؛ در چنین مطلبی سعی کنید کامل باشید و تمام حالت های ممکن را فهرست کنید. یک راهنمای نحوه انجام کار تخصصی می تواند این باشد: "چگونه عنوان مطلب را نمایش دهیم؟" که تنظیمات را در تنظیمات کلی مطلب و در تنظیمات فردی مطلب و آیتم منو نشان می دهد. یک مطلب از نوع توضیحات می تواند درباره پس زمینه این موضوع صحبت کند که چرا جوملا از "مطلب" استفاده می کند در حالی که مثلاً وردپرس از "پست" استفاده می کند، یا اینکه مطلب چگونه در صفحه نهایی رندر می شود.
نتیجه گیری
همه چیز را در یک خلاصه جمع بندی کنید. و برخی مراحل بعدی احتمالی برای یادگیری بیشتر را ذکر کنید (مانند: یک آموزش درباره افزودن یک مجموعه یا یک راهنمای نحوه انجام کار درباره میانبر ذخیره در منو).
تصاویر و گرافیک ها
تصاویر صفحه ای بسازید که دکمه ها و فیلدهای مربوط به ایجاد یک مطلب و یک آیتم منو را نشان دهد. دکمه ها و فیلدهای مربوطه را مشخص کنید.
برای وضوح بیشتر می توانید نموداری اضافه کنید که نشان دهد چگونه یک مطلب "زیر" یک آیتم منو قرار می گیرد.
افزودن مراجع، راهنماهای نحوه انجام کار و توضیحات
تمام اطلاعات و دستورالعمل های اضافی را در مطالب جداگانه قرار دهید.
نمای کلی
اگر چندین مطلب درباره یک موضوع دارید، باید یک مطلب نمای کلی بسازید که توضیح دهد مطالب چگونه با هم ارتباط دارند و از کجا باید شروع کرد.
تمرین
شروع به ساختن آموزش بالا کنید که چگونه یک مطلب در جوملا ایجاد و منتشر شود. بهترین راه برای یادگیری انجام دادن است. ما نمونه ای از اینکه این می تواند چگونه باشد را در راهنمای کاربری فعلی این سایت منتشر خواهیم کرد. اما اگر بتوانید نسخه صحیح را بهبود دهید، خوشحال می شویم نسخه شما را در آنجا قرار دهیم.
(این مطلب همچنین در مجله جامعه جوملا در فوریه 2025 منتشر شده است)