پایگاه دانش انبار مقاله نیست. اگر مشتری برای پیدا کردن روش فعالسازی مجبور باشد نام داخلی تنظیم را بداند، ساختار از نگاه تیم نوشته شده است نه کاربر. مستندات موفق از وظیفه و پرسش آغاز میشوند، کوتاهترین مسیر رسیدن به نتیجه را نشان میدهند و محدودیت را پنهان نمیکنند.
منبع موضوعات واقعی
درخواستهای پشتیبانی، عبارتهای جستوجوی بدون نتیجه، مرحله رهاشده Onboarding و خطاهای پرتکرار بهترین فهرست اولیهاند. موضوع را براساس حجم سؤال، اثر مشکل و امکان حل بدون دسترسی انسانی اولویتبندی کنید. مقالهای که هیچکس به آن نیاز ندارد با طول بیشتر مفید نمیشود.
معماری قابل پیشبینی
- شروع سریع و نصب؛
- تنظیم قابلیتهای اصلی؛
- لایسنس، بهروزرسانی و حساب؛
- اتصالها و سناریوهای پیشرفته؛
- عیبیابی براساس نشانه؛
- حریم خصوصی، حذف و انتقال داده.
یک مقاله را در چند دسته تکرار نکنید؛ صفحه اصلی واحد داشته باشد و از مسیرهای مختلف به آن لینک شود. Breadcrumb و عنوان دسته باید موقعیت کاربر را روشن کنند.
قالب یک مقاله اجرایی
- نتیجهای که کاربر میگیرد و پیشنیازها؛
- مراحل شمارهدار با نام دقیق گزینهها؛
- تصویر فقط در نقطهای که ابهام را کم میکند؛
- نتیجه قابل مشاهده پس از هر مرحله مهم؛
- خطاهای رایج و راه بازگشت؛
- نسخه محصول و تاریخ آخرین بازبینی؛
- لینک مرحله بعد و مسیر پشتیبانی.
زبان جستوجوی مشتری
کاربر ممکن است «کلید کار نمیکند» بنویسد، نه «خطای فعالسازی لایسنس». واژههای رایج، شکل فارسی و انگلیسی نام قابلیت و نشانه خطا را طبیعی در عنوان و متن بیاورید. نتیجه جستوجو باید خلاصهای نشان دهد که تفاوت مقالهها روشن باشد.
مستندات مالک و چرخه انتشار میخواهد
هر تغییر رابط یا رفتار باید یک وظیفه بررسی مستندات داشته باشد. مالک محتوا پیش از انتشار نسخه، لینکها، تصویرها و مراحل را آزمایش کند. مقاله قدیمی را یا اصلاح و تاریخ را ثبت کنید یا با Redirect به راهنمای جایگزین ببرید؛ دو دستور متناقض اعتماد را از بین میبرد.
موفقیت را چگونه بسنجیم؟
نرخ رسیدن از جستوجو به مقاله، جستوجوی دوباره، رأی مفید بودن و تیکت ثبتشده پس از مطالعه اطلاعات خوبی میدهند. کاهش تیکت تنها معیار نیست؛ بعضی مستندات خوب باعث میشوند مشتری مسئله پیچیده را دقیقتر گزارش کند و زمان حل کوتاه شود.
بهترین مقاله راهنما مقالهای نیست که همه چیز را توضیح دهد؛ مقالهای است که کاربر را با کمترین تردید به نتیجه مشخص برساند.
ساختار فعلی مستندات Plugen میتواند با همین الگو برای هر محصول توسعه پیدا کند و از صفحه محصول به راهنمای مرتبط پیوند بخورد.
