چندی پیش نوشته‌ای در وبلاگم منتشر کردم درباره راه‌های بهبود مستنداتی که تولید می‌کنیم و امروز نسخه کامل‌تری رو منتشر می‌کنم.

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

قراره خیلی حاشیه نریم و به اصل مطلب بپردازیم. در ادامه می‌تونید گام‌های مورد نظر رو مطالعه کنید.

مقدمه

مستندسازی از دیدگاه اغلب کارشناسان، کاری کسل‌کننده و تلف‌کننده وقت است. معمولا کارشناسان وظیفه خطیر مستندسازی به را عنوان کم ارزش‌ترین جزء فعالیت‌های روزانه برخورد می‌دانند. اما در واقع مستندسازان متبهر و دست‌به‌قلم، نقشی بسیار مهم‌تر از اعتباری که به آن داده شده را در شرکت‌ها و سازمان‌ها بازی می‌کنند.

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

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

۱-    درک مخاطبین

یکی از مهم‌ترین مسائلی که به شما در بهبود مستندات کمک می‌کند، دریافت درک مناسبی از مخاطب مستند است. کشف آمار دقیق کاربران از نظر سن، سطح آگاهی از موضوع، قصد آنها از مطالعه مستند، امری ضروری است. بعد از دریافت چنین دانش و اطلاعاتی می‌توانید درباره‌ سطح مستند تصمیم‌گیری نمایید؛ لحن و زبان گویش، عمق مطالبی که باید عنوان شود و مقیاس‌هایی که مناسب مستند است.

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

از طرفی هنگامی قصد تشریح موضوعی را به منظور آموزش، تحلیل و سایر موارد دارید، به جزییات بپردازید، مثال‌های کافی و ملموس بیاورید و البته باز هم از حاشیه‌روی دوری کنید.

۲-    تعیین حوزه

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

یکی از کاربردی‌ترین راه‌حل‌ها، پاسخ به این سوال است که «چرا این مستند را تهیه می‌کنم؟».

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

۳-    تعریف قرارداد‌های قالب و شمایل مستند

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

البته بسیاری از شرکت‌ها و سازمان‌ها دارای چند قالب مشخص برای مصارف خاص هستند که استفاده از آن‌ها نه تنها از سربار مستندات می‌کاهد، بلکه می‌تواند نشانه‌ای از بلوغ و بهره‌وری سازمان و استفاده بهینه از امکانات مختلف باشد.

مثال: بسیاری از مستندات از جداول برای ارائه‌ اطلاعات در روشی ساخت‌یافته، بهره می‌جویند. یکی از روش های متداول برای شماره‌گذاری جداول، استفاده از ترکیب فصل و شماره جدول است. برای مثال نام جدول ۴-۱۵ بیان‌گر چهارمین جدول فصل ۱۵ است.

۴-    ایجاد پیش‌نویس فهرست مطالب

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

مثال: عنوان متداول برای راهنمای کاربری می‌تواند، معرفی، نصب، کاربری، مدیریت، عیب‌یابی، ضمیمه‌ها و نمایه باشد.

۵-    نهایی کردن فهرست مطالب، شروع ایجاد مستند

پس از ایجاد پیش‌نویس فهرست مطالب، تمام فکر و ذهن خود را بر روی جمع‌آوری تمام اطلاعاتی که برای ایجاد مستند نیاز دارید، متمرکز کنید. به هنگام جمع‌آوری داده‌ها، آنها را با توجه به پیش‌نویس فهرست، امتحان و بازآزمایی کنید تا اطمینان حاصل کنید که «جایی برای هر چیز هست و هر چیز جایی دارد». حتما باید زیرعنوان‌های پیش‌نویس را برای اصلاح هر چه بهتر جزئیات اطلاعاتی، تغییر دهید؛ این امری طبیعی است و در جدول زمان‌بندی‌تان هم باید برنامه‌ای برای آن داشته باشید. پس از سازمان‌دهی همه اطلاعات و نهایی کردن فهرست مطالب، کار اصلی برای تولید محتوا آغاز می‌شود.

۶-    استفاده از تصویر و نمودار

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

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

۷-    انجام بازنگری محتوایی، فنی و کاربری

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

به عنوان مثال در گزارشات مدیریتی، حتما کلیدواژه‌ها و خط مشی کلی مستند از با تحویل گیرنده در میان گذارید و مطمئن شوید که به تمامی جنبه‌های مورد نظر پرداخته‌اید.

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

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

پیشنهاد می‌شود برای آزمون مستند از یکی از دوستان یا همکاری که با موضوع آشنا است، کمک بگیرید تا خود مستند آینه تمام نمای زحمات شما باشد.