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