راهنماهای عملی

ساختار

پنج راهنمای عملی فعلی ابتدا به عنوان مطلب در مجله انجمن جوملا منتشر شدند که توسط برایان تیمن نوشته شده و توسط او برای این مستندات ارسال شده اند.

ما هنوز در حال کار بر روی ساختارهای منو برای قرار دادن راهنماهای عملی، آموزش ها، توضیحات و غیره هستیم به گونه ای که بتوانند به صورت پویا فیلتر و مرتب شوند. اما فعلاً این راهنماهای عملی را به ترتیب تصادفی منتشر خواهیم کرد.

درباره راهنماهای عملی

از https://diataxis.fr/how-to-guides/:

راهنماهای عملی دستورالعمل هایی هستند که خواننده را از میان یک مشکل یا به سمت یک نتیجه راهنمایی می کنند. راهنماهای عملی هدف گرا هستند.

یک راهنمای عملی به کاربر کمک می کند تا کاری را به درستی و با امنیت انجام دهد؛ این راهنما اقدام کاربر را هدایت می کند.

این راهنما به کار مربوط می شود - حرکت از یک سمت به سمت دیگر یک حوزه مسئله در دنیای واقعی.

نمونه هایی می تواند این باشد: چگونه آرایه رادار را کالیبره کنیم؛ چگونه از fixtures در pytest استفاده کنیم؛ چگونه سیاست های back-off اتصال مجدد را پیکربندی کنیم. از طرف دیگر، چگونه یک برنامه وب بسازیم چنین نیست - این به یک هدف یا مشکل خاص نمی پردازد، بلکه حوزه ای بسیار باز از مهارت است.

راهنماهای عملی اهمیت دارند نه فقط به این دلیل که کاربران باید بتوانند کارها را انجام دهند: فهرست راهنماهای عملی در مستندات شما به شکل گیری تصویری از آنچه محصول شما واقعاً می تواند انجام دهد کمک می کند. فهرستی غنی از راهنماهای عملی نشان دهنده امیدوارکننده ای از قابلیت های یک محصول است.