درس ۱ از ۱۰

چرا مستندسازی بخشی از کار فنی است

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

این درس برای مطالعه کامل نوشته شده است

با حوصله بخوان، مثال‌ها را تحلیل کن و تمرین‌ها را انجام بده؛ هدف حفظ کردن تعریف‌ها نیست

Documentation دانش را از حافظه افراد جدا می‌کند

مستندسازی دانش را از حافظه یک فرد جدا می‌کند؛ اگر کارشناس در دسترس نباشد نفر بعد باید بتواند از روی مستند مسیر شبکه، سرویس و تصمیم‌های قبلی را بفهمد مستندسازی زیرساخت باید آن‌قدر دقیق باشد که وضعیت فعلی را بدون تکیه به حافظه افراد بازسازی کند؛ Inventory دارایی‌ها، Diagram ارتباطات، IP Plan، VLANها، نقش Serverها، مسیر Backup، وابستگی سرویس‌ها و تاریخچه تغییرات هر کدام بخشی از تصویر هستند؛ اطلاعات Credential بهتر است در محل امن و جدا از سند عمومی زیرساخت نگهداری شود؛ هر تغییر مهم نیز باید بعد از اجرا در مستندات منعکس شود تا سند با محیط واقعی فاصله نگیرد در کار روزمره بهتر است این موضوع را این‌طور بررسی کنی: اطلاعات محرمانه مانند Password و Recovery Key بهتر است از سند عمومی زیرساخت جدا و در مخزن امن مدیریت شوند؛ در سند اصلی می‌توان محل نگهداری Credential و مسئول آن را ثبت کرد بدون افشای خود Secret؛ بعد از هر تغییر مهم، Update مستند باید بخشی از Closure کار باشد تا نسخه مستند با شبکه واقعی اختلاف پیدا نکند

زمان عیب‌یابی را کم می‌کند

مستند درست باعث می‌شود IP، Port، مسئول، وابستگی و تنظیم قبلی را دوباره کشف نکنی؛ این زمان ذخیره‌شده در رخداد واقعی می‌تواند مستقیماً Downtime را کم کند مستندسازی زیرساخت باید آن‌قدر دقیق باشد که وضعیت فعلی را بدون تکیه به حافظه افراد بازسازی کند؛ Inventory دارایی‌ها، Diagram ارتباطات، IP Plan، VLANها، نقش Serverها، مسیر Backup، وابستگی سرویس‌ها و تاریخچه تغییرات هر کدام بخشی از تصویر هستند؛ اطلاعات Credential بهتر است در محل امن و جدا از سند عمومی زیرساخت نگهداری شود؛ هر تغییر مهم نیز باید بعد از اجرا در مستندات منعکس شود تا سند با محیط واقعی فاصله نگیرد روش عیب‌یابی قابل اتکا از تعیین دامنه مشکل شروع می‌شود: یک User یا چند User، یک Device یا یک Segment، یک Service یا همه سرویس‌ها؛ بعد باید تغییر اخیر و شواهد قابل مشاهده جمع شوند و فرضیه‌ها از کم‌ریسک‌ترین تست‌ها بررسی شوند؛ تغییر چند عامل هم‌زمان تشخیص علت را دشوار می‌کند؛ پس از رفع نیز باید سرویس از دید کاربر تأیید، علت ثبت و در صورت نیاز اقدام پیشگیرانه تعریف شود

تاریخ و مسئول و Version لازم است

نسخه و تاریخ مستند مشخص می‌کند کارشناس روی اطلاعات قدیمی تصمیم نگیرد و بداند آخرین تغییر چه زمانی ثبت شده است مستندسازی زیرساخت باید آن‌قدر دقیق باشد که وضعیت فعلی را بدون تکیه به حافظه افراد بازسازی کند؛ Inventory دارایی‌ها، Diagram ارتباطات، IP Plan، VLANها، نقش Serverها، مسیر Backup، وابستگی سرویس‌ها و تاریخچه تغییرات هر کدام بخشی از تصویر هستند؛ اطلاعات Credential بهتر است در محل امن و جدا از سند عمومی زیرساخت نگهداری شود؛ هر تغییر مهم نیز باید بعد از اجرا در مستندات منعکس شود تا سند با محیط واقعی فاصله نگیرد در یک شبکه یا سیستم واقعی، این موضوع زمانی روشن می‌شود که سند خوب باید به یک نفر دیگر امکان بدهد محیط را بدون حدس زدن بفهمد؛ Diagram، Inventory، IP Plan، VLAN Plan، Server Roles، Backup Flow، Contactها و تاریخچه Change هر کدام هدف جدا دارند؛ سندی که همه چیز را در یک صفحه یا فقط در ذهن یک نفر نگه دارد در زمان خرابی کمک محدودی می‌کند در کار روزمره بهتر است این موضوع را این‌طور بررسی کنی: اطلاعات محرمانه مانند Password و Recovery Key بهتر است از سند عمومی زیرساخت جدا و در مخزن امن مدیریت شوند؛ در سند اصلی می‌توان محل نگهداری Credential و مسئول آن را ثبت کرد بدون افشای خود Secret؛ بعد از هر تغییر مهم، Update مستند باید بخشی از Closure کار باشد تا نسخه مستند با شبکه واقعی اختلاف پیدا نکند

مستند قدیمی خطرناک است

مستندی که با محیط واقعی فرق دارد می‌تواند از نبود مستند هم خطرناک‌تر باشد چون کارشناس را با اعتماد اشتباه هدایت می‌کند؛ تاریخ بازبینی و مسئول مستند را مشخص نگه دار مستندسازی زیرساخت باید آن‌قدر دقیق باشد که وضعیت فعلی را بدون تکیه به حافظه افراد بازسازی کند؛ Inventory دارایی‌ها، Diagram ارتباطات، IP Plan، VLANها، نقش Serverها، مسیر Backup، وابستگی سرویس‌ها و تاریخچه تغییرات هر کدام بخشی از تصویر هستند؛ اطلاعات Credential بهتر است در محل امن و جدا از سند عمومی زیرساخت نگهداری شود؛ هر تغییر مهم نیز باید بعد از اجرا در مستندات منعکس شود تا سند با محیط واقعی فاصله نگیرد برای عیب‌یابی درست، این بخش را فقط به‌عنوان یک اصطلاح حفظ نکن و توجه داشته باش که سند خوب باید به یک نفر دیگر امکان بدهد محیط را بدون حدس زدن بفهمد؛ Diagram، Inventory، IP Plan، VLAN Plan، Server Roles، Backup Flow، Contactها و تاریخچه Change هر کدام هدف جدا دارند؛ سندی که همه چیز را در یک صفحه یا فقط در ذهن یک نفر نگه دارد در زمان خرابی کمک محدودی می‌کند

به‌روزرسانی مستند بخشی از تغییر است

اگر تغییر واقعی انجام شد ولی Diagram، IP Plan یا Runbook قدیمی ماند، محیط و مستند از هم جدا می‌شوند؛ تغییر زمانی کامل است که مستند مرتبط هم اصلاح و Version شود مستندسازی زیرساخت باید آن‌قدر دقیق باشد که وضعیت فعلی را بدون تکیه به حافظه افراد بازسازی کند؛ Inventory دارایی‌ها، Diagram ارتباطات، IP Plan، VLANها، نقش Serverها، مسیر Backup، وابستگی سرویس‌ها و تاریخچه تغییرات هر کدام بخشی از تصویر هستند؛ اطلاعات Credential بهتر است در محل امن و جدا از سند عمومی زیرساخت نگهداری شود؛ هر تغییر مهم نیز باید بعد از اجرا در مستندات منعکس شود تا سند با محیط واقعی فاصله نگیرد Change Enablement بر این تأکید دارد که تغییر با ارزیابی ریسک، مجوز متناسب، زمان‌بندی، برنامه اجرا، معیار موفقیت و راه بازگشت کنترل شود؛ حتی تغییر کوچک اگر روی سرویس مشترک انجام شود می‌تواند دامنه اثر بزرگی داشته باشد؛ قبل از اجرا باید وضعیت فعلی ثبت شود، وابستگی‌ها شناخته شوند و بعد از تغییر هم آزمون فنی و تأیید کارکرد سرویس انجام شود؛ اگر شرایط از برنامه خارج شد، توقف و Rollback بخشی از اجرای حرفه‌ای است

مثال محیط واقعی

فرض کن در مستندات زیرساخت مشکلی گزارش شده و احتمال می‌دهی به چرا مستندسازی بخشی از کار فنی است مربوط باشد. قبل از تغییر، وضعیت فعلی را با Topology، Inventory، IP Plan و مستندات دسترسی بررسی می‌کنی و نتیجه را با یک حالت سالم یا مستند معتبر مقایسه می‌کنی. اگر شواهد فرضیه را تأیید کردند، فقط همان بخش مرتبط را تغییر می‌دهی و بعد همان تست را دوباره اجرا می‌کنی تا مطمئن شوی مشکل واقعاً برطرف شده است

اشتباهات رایج

این اشتباه‌ها را تکرار نکن

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

حالا خودت انجام بده

  1. در یک نمونه آزمایشی مرتبط با چرا مستندسازی بخشی از کار فنی است، فقط وضعیت فعلی را مشاهده کن و سه نکته‌ای را که برای تشخیص حالت سالم مهم‌اند یادداشت کن
  2. با Topology، Inventory، IP Plan و مستندات دسترسی وضعیت مرتبط با چرا مستندسازی بخشی از کار فنی است را بدون تغییر بررسی کن، سه داده واقعی جمع کن و توضیح بده هرکدام چه چیزی به تو می‌گویند
  3. یک خطای فرضی مرتبط با چرا مستندسازی بخشی از کار فنی است بنویس و مشخص کن اولین تست کم‌خطر تو چیست و چه نتیجه‌ای فرضیه‌ات را رد می‌کند

نکته‌هایی که باید با خودت ببری

  • Documentation دانش را از حافظه افراد جدا می‌کند
  • زمان عیب‌یابی را کم می‌کند
  • تاریخ و مسئول و Version لازم است
  • مستند قدیمی خطرناک است
  • به‌روزرسانی مستند بخشی از تغییر است
  • Secretها را از مستند عمومی زیرساخت جدا نگه دار
خودسنجی

قبل از رفتن به درس بعد، جواب را برای خودت توضیح بده

این نکته را با یک مثال توضیح بده: Documentation دانش را از حافظه افراد جدا می‌کند. بعد بگو در عمل چطور آن را بررسی می‌کنی.

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

این نکته را با یک مثال توضیح بده: زمان عیب‌یابی را کم می‌کند. بعد بگو در عمل چطور آن را بررسی می‌کنی.

مستند درست باعث می‌شود IP، Port، مسئول، وابستگی و تنظیم قبلی را دوباره کشف نکنی. این زمان ذخیره‌شده در رخداد واقعی می‌تواند مستقیماً Downtime را کم کند

این نکته را با یک مثال توضیح بده: تاریخ و مسئول و Version لازم است. بعد بگو در عمل چطور آن را بررسی می‌کنی.

نسخه و تاریخ مستند مشخص می‌کند کارشناس روی اطلاعات قدیمی تصمیم نگیرد و بداند آخرین تغییر چه زمانی ثبت شده است

مطالعه درس همیشه عمومی است

برای ذخیره پیشرفت، دوره را رسمی شروع کن

با ثبت‌نام، تکمیل درس‌ها و نمره آزمون روی حساب ذخیره می‌شود

ثبت‌نام و شروع رسمی