کاربری که سند را می خواند
نوشتن مستندات خوب برای هر نرم افزار کار آسانی نیست. نکات زیادی وجود دارد که باید هنگام انجام کارهای روزمره خود در نظر داشته باشید. همه آنها، و همچنین مهارت و تلاش شما، متن شما را به یک سند بسیار قابل استفاده تبدیل می کند.
بیایید اولین چیزی را که باید در هنگام شروع کار خود در نظر بگیرید بحث کنیم: کاربر. کاربر که به عنوان “مشتری” نیز شناخته می شود، انسانی است که نماینده گروه هدف است. گروه هدف از مستندات در کارهای روزمره خود استفاده خواهند کرد تا نحوه استفاده از نرم افزار را برای برآوردن نیازهای حرفه ای خود بیابند.
مستندات باید مانند توصیه های مفیدی باشد که توسط یک متخصص با تجربه و دوستانه ارائه شده است – این مورد نیاز رایج از راهنماهای سبک شرکتی است. برای پرداختن به آن، باید کاملاً درک کنید که چه کسی اسناد را می‌خواند و چرا.
برای دستیابی به این درک، پاسخ سؤالات اساسی را بیابید (تیم های محصول و مهندسی ممکن است در این مورد به شما کمک کنند). بیایید این سوالات را مرور کنیم.
نرم افزار چیست و چگونه استفاده می شود؟
این اطلاعات به شما نشان می دهد:
همچنین، با یادگیری نرم افزار، مشکلات، قطعات پیچیده و سایر منابع مشکل برای کلاینت را پیدا خواهید کرد که می توان آنها را برطرف کرد یا در Doc پوشش داد.
به یاد داشته باشید، هیچ کس سند را به عنوان یک کتاب نمی خواند. همه…