مستنداتی بنویسید که واقعاً باز شوند

مشکل خیلی از مستندات این نیست که کم هستند؛ این است که برای خوانده شدن طراحی نشده‌اند. سندی که با مقدمه‌های طولانی شروع می‌شود، مسیر مشخص ندارد و جواب سؤال اجرایی را سریع نمی‌دهد، در عمل کنار گذاشته می‌شود. تیم در لحظه کار، حوصله جست‌وجوی طولانی ندارد. مستند خوب باید سریع به مقصد برساند.

مستندات مصرف‌پذیر، طولانی نیستند؛ قابل اسکن، قابل لینک و نزدیک به مسئله‌اند.

چرا مستندات استفاده نمی‌شوند؟

چون یا خیلی کلی‌اند، یا قدیمی‌اند، یا پیدا کردن‌شان سخت است. گاهی هم نویسنده می‌خواهد همه‌چیز را یک‌جا توضیح دهد، در حالی که کاربر فقط دنبال پاسخ یک سؤال مشخص است.

ساختار بهتر چیست؟

عنوان روشن، خلاصه کوتاه، مراحل یا تصمیم‌های مشخص، و لینک به جزئیات تکمیلی. این ساختار کمک می‌کند هم تازه‌وارد و هم فرد باتجربه سریع‌تر به پاسخ برسند.

بهینه‌سازی واقعی

هر صفحه‌ای که زیاد باز می‌شود ولی باز هم سؤال تکراری تولید می‌کند، نیاز به بازنویسی دارد.

جمع‌بندی و اقدام

• مستندات پرکاربرد را بر اساس سؤال واقعی کاربران بازنویسی کنید
• صفحه‌ها را کوتاه، اسکن‌پذیر و قابل لینک نگه دارید
• برای موضوعات پیچیده، خلاصه اجرایی را بالای صفحه بگذارید
• استفاده‌نشدن از مستند را نشانه کیفیت پایین محتوا یا دسترسی بدانید، نه تنبلی تیم