مستندنویسی برای وبسایت‌های تخصصی

مستندنویسی؛ مهمترین متن یک سرویس‌دهنده + ویدیو

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

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

منظور از سرویس‌دهنده چیست؟

وبسایت‌هایی هستند که به صورت کامل محتوا محور بوده و مخاطب برای استفاده از اون وبسایت‌ها نیازی به راهنمایی و مواردی از این دست ندارد. مثال: وبسایت‌های خبری، وبلاگی، گالری، نمونه کار و… .

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

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

حالا سوال اصلی اینه که این مستندات رو باید به چه صورتی نوشت؟ در ادامه نکات کلیدی برای این موضوع رو بهتون معرفی می‌کنم.

مستند‌نویسی؛ مشخص کردن مخاطب

به صورت کلی می‌توان دو نوع مخاطب را برای وبسایت‌های سرویس‌دهنده در نظر داشت: مخاطب عمومی و مخاطب تخصصی.

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

اما وبسایت‌هایی هستند (برای مثال ارائه دهنده خدمات ابری) که استفاده کنندگان از این وبسایت‌ها مخاطبین خاص بوده و افرادی سراغ چنین وبسایت‌هایی می‌روند که از دانش فنی برخوردار هستند. برای مثال برنامه‌نویس‌ها. در این حالت مستندات شما باید با تاکید کامل روی تک تک سرویس‌هایی که ارائه می‌دهید همراه با Usecaseهای مربوطه نوشته شود.

مستند‌نویسی؛ ساختار مطلب محتوای عمومی

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

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

برای مثال می‌توانید عناوین زیر را به عنوان راهنماهای اصلی در نظر بگیرید:

  • راهنمای ثبت نام و ورود به وبسایت
  • راهنمای جستجو محصول
  • راهنمای انتخاب محصول
  • راهنمای ثبت سفارش
  • راهنمای نهایی کردن خرید
  • و… .

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

مستندنویسی؛ ساختار مطلب محتوای تخصصی

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

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

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

مستندنویسی؛ قالب متنی مستندات تخصصی

قالب محتوای مستندات و مستندنویسی
شیوه نگارش مستندات و ارائه یک قالب یکپارچه || منبع تصویر

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

در قالب محتوایی به عنوان یک پیشنهاد کلیدی سعی کنید موارد زیر را رعایت کنید:

مقدمه

یک مقدمه کاربردی و جذاب برای هر سرویس بنویسید. توی این مقدمه سعی کنید با استفاده از خطی مشی Story Telling یک داستان از مشکلی را روایت کنید که این سرویس قرار است آن را حل بکند. به مثال زیر توجه کنید:

بسیاری از وبسایت‌ها دوست دارند تا بدون دردسر یک سرویس ایمیل مارکتینگ داشته باشند، اما مدیریت ایمیل‌ها، کاربران بسیار زیاد، ایجاد فرم جذاب برای ایمیل‌ها و... از جمله مشکلاتی هستند که این کار را برای بسیاری از شرکت‌ها به یک مشکل تبدیل کرده است. حال ما با ارائه سرویس جذاب «ایمیل مارکتینگ» قصد داریم این مشکل را به صورت کامل برای شما حل کنیم.

بدنه اصلی

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

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

همچنین اگر در ساخت/استفاده از یک سرویس نیاز به یک راهنما قدم به قدم وجود دارد مطمئن شوید که در این بخش به صورت لیست یا تایتل‌های مرحله محور آن‌ها را مستند کنید. مثال:

  • مرحله اول: ورود به سرور
    • توضیحات لازم
  • مرحله دوم: ایجاد یک کلید SSH
    • توضیحات لازم
  • مرحله سوم: ورود به ترمینال
    • توضیحات لازم
  • مرحله چهارم: نصب ابزارهای SSH
    • توضیحات لازم

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

بخش پایان

در متن نهایی هر مستند سعی کنید شرحی کلی از سرویسی که ارائه دادید بنویسید و همچنین لینک‌های مرتبط با این سرویس را پروموت کنید.

مستندنویسی؛ چگونگی انجام آن

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

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

حال نوبت نویسنده است که با در کنار هم قرار دادن فاکتورهای مختلفی که از متخصص آن سرویس دریافت کرده، مستند مربوطه را بنویسد.

مستندنویسی؛ من را استخدام کن!

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

منتشرشده توسط

ارسطو عباسی

تکنیکال کانتنت رایتر – نویسنده حوزه فناوری – کپی‌رایتر – گیک || فلسفه و ادبیات خوان حرفه‌ای - علاقه‌مند به مطالعه نرم افزار آزاد

دیدگاهتان را بنویسید

نشانی ایمیل شما منتشر نخواهد شد. بخش‌های موردنیاز علامت‌گذاری شده‌اند *