IT Documentation & Architecture
مستندسازی و معماری زیرساخت
زیرساختی که فقط یک نفر آن را می‌شناسد، یک ریسک عملیاتی است — صرف‌نظر از اینکه آن یک نفر چقدر توانمند باشد.
معرفی تخصصی
مستندسازی و معماری در عمل چه کاری انجام می‌دهد
مستندسازی معمولاً اولین کاری است که از برنامه حذف می‌شود و آخرین چیزی که فقدانش گران تمام می‌شود. هزینهٔ آن در روزهای عادی صفر به‌نظر می‌رسد و در روز حادثه، تعطیلات یا خروج یک همکار کلیدی یکجا پرداخت می‌شود.
مستندسازی مفید، نوشتن همه‌چیز نیست. نوشتن چیزهایی است که در لحظهٔ فشار به آن‌ها نیاز می‌شود: این سرویس کجا اجرا می‌شود، به چه چیزی وابسته است، چه کسی مالک آن است و اگر از کار بیفتد چه باید کرد.
ما مستندات را به‌عنوان یک دارایی سازمانی تحویل می‌دهیم، نه یک پیوست پروژه: در قالبی که سازمان بتواند خودش آن را به‌روز نگه دارد، با چرخه‌ای که از فرسوده شدنش جلوگیری کند.
مسئله
چه مشکلی را حل می‌کند
در بیشتر سازمان‌ها، مستندات یا وجود ندارند یا آن‌قدر قدیمی‌اند که اتکا به آن‌ها از نداشتنشان خطرناک‌تر است. نقشه‌ای که وضعیت دو سال پیش را نشان می‌دهد، در عیب‌یابی به بیراهه می‌برد.
نتیجهٔ عملی این است که هر تغییری نیازمند حضور فردی است که ساختار را در ذهن دارد، و هر عیب‌یابی با بازکشف همان اطلاعات شروع می‌شود.
- نبود نقشهٔ به‌روز از معماری و وابستگی سرویس‌ها
- اطلاعات زیرساخت در ذهن یک یا دو نفر، بدون نسخهٔ مکتوب
- نبود فهرست دارایی و در نتیجه نامشخص بودن تاریخ پایان پشتیبانی تجهیزات
- تغییراتی که بدون ثبت انجام می‌شوند و بعداً قابل ردیابی نیستند
- نبود رویهٔ عملیاتی برای کارهای تکرارشونده و شرایط اضطراری
- مستنداتی که یک بار نوشته شده و هرگز به‌روز نشده است
کاربرد سازمانی
کجا به این خدمت نیاز پیدا می‌شود
تحویل و انتقال دانش
آماده‌سازی مستندات برای تغییر پیمانکار یا ورود همکار فنی جدید، بدون وابستگی به انتقال شفاهی.
پشتیبانی از عیب‌یابی
در اختیار داشتن نگاشت وابستگی‌ها، تا هنگام بروز اختلال مسیر بررسی مشخص باشد.
برنامه‌ریزی تغییر و ارتقا
ارزیابی اثر یک تغییر پیش از اجرا، بر پایهٔ نقشهٔ وابستگی به‌جای حافظه.
آمادگی برای ممیزی
در دسترس بودن فهرست دارایی، دسترسی‌ها و سوابق تغییر، هنگام بررسی داخلی یا بیرونی.
معماری پیشنهادی
ساختاری که پیشنهاد می‌کنیم
مجموعهٔ مستندات در چهار بخش ساخته می‌شود؛ هر بخش یک پرسش مشخص را در لحظهٔ نیاز پاسخ می‌دهد.
برای دیدن کامل نمودار، آن را به چپ و راست بکشید.
- نقشهٔ معماریتصویر کلی زیرساخت و ارتباط اجزا: شبکه، سرورها، سرویس‌ها و مسیرهای دسترسی، در سطحی که قابل فهم و قابل نگهداری باشد.
- فهرست داراییثبت تجهیزات و سرویس‌ها با مشخصات، مالک، تاریخ پایان پشتیبانی و وابستگی‌ها.
- رویه‌های عملیاتیدستورالعمل کارهای تکرارشونده و شرایط اضطراری، نوشته‌شده برای اجرا در فشار: کوتاه، مرحله‌ای و بدون ابهام.
- سابقهٔ تغییراتثبت تغییرات مهم و دلیل آن‌ها، تا تصمیم‌های گذشته برای تیم بعدی قابل فهم باشد.
قابلیت‌ها
اجزا و قابلیت‌های فنی
کشف و نگاشت زیرساخت
بررسی وضعیت موجود و ترسیم نقشهٔ واقعی معماری، نه آنچه قرار بوده باشد.
تهیهٔ فهرست دارایی
ثبت تجهیزات و سرویس‌ها با مالک، مشخصات و وضعیت پشتیبانی، در قالبی قابل نگهداری.
نگاشت وابستگی سرویس‌ها
مشخص کردن اینکه هر سرویس به چه چیزی وابسته است و توقف آن چه چیزی را متوقف می‌کند.
تدوین رویه‌های عملیاتی
نوشتن دستورالعمل کارهای تکراری و سناریوهای اضطراری، به زبان قابل اجرا.
چارچوب مدیریت تغییر
تعریف فرایند سبک برای ثبت تغییرات، متناسب با اندازهٔ تیم و بدون تبدیل شدن به بوروکراسی.
آموزش و تحویل
آموزش تیم داخلی برای نگهداشت مستندات، تا پس از پایان همکاری هم به‌روز بمانند.
مزیت‌ها
چه چیزی در عملیات روزمره تغییر می‌کند
استقلال از افراد
دانش زیرساخت از ذهن افراد به دارایی سازمان منتقل می‌شود.
عیب‌یابی سریع‌تر
نقشهٔ وابستگی، مسیر بررسی را کوتاه و هدفمند می‌کند.
تغییر با ریسک کمتر
اثر هر تغییر پیش از اجرا قابل ارزیابی است.
انتقال بدون اصطکاک
ورود همکار جدید یا تغییر پیمانکار به بحران تبدیل نمی‌شود.
سناریوهای استفاده
سه وضعیت پرتکرار و پاسخ ما به آن‌ها
این سناریوها الگوی طراحی‌اند، نه شرح پروژه‌های انجام‌شده؛ برای هر سازمان با اندازه‌گیری وضعیت واقعی بازنویسی می‌شوند.
- وضعیت
سازمانی که تنها کارشناس فنی آشنا به زیرساختش در آستانهٔ ترک مجموعه است.
رویکردجلسات کشف ساختاریافته با همان کارشناس، ثبت نقشهٔ معماری و وابستگی‌ها، تدوین رویه‌های عملیاتی و اعتبارسنجی مستندات با اجرای آزمایشی توسط فرد دیگر.
نتیجهٔ مورد انتظاردانش پیش از خروج آن فرد مکتوب و آزموده می‌شود و انتقال بدون وقفه انجام می‌گیرد.
- وضعیت
مجموعه‌ای که هنگام هر اختلال، بخش زیادی از زمان صرف کشف دوبارهٔ ساختار شبکه می‌شود.
رویکردتهیهٔ نقشهٔ به‌روز، فهرست دارایی و نگاشت وابستگی سرویس‌ها، به‌همراه چرخهٔ بازبینی دوره‌ای.
نتیجهٔ مورد انتظارزمان عیب‌یابی کوتاه می‌شود، چون بررسی از نقطهٔ درست و با تصویر کامل شروع می‌گردد.
مراحل اجرا
از ارزیابی تا بهره‌برداری
کشف و گردآوری
بررسی وضعیت موجود، مصاحبه با تیم فنی و استخراج اطلاعات از تجهیزات و سرویس‌ها.
ساختاردهی و تدوین
تولید نقشه، فهرست دارایی، نگاشت وابستگی و رویه‌های عملیاتی در قالب استاندارد.
اعتبارسنجی
بررسی صحت مستندات با اجرای آزمایشی رویه‌ها توسط فردی غیر از نویسنده.
تحویل و نگهداشت
تحویل به سازمان، آموزش نگهداشت و تعریف چرخهٔ بازبینی دوره‌ای.
فناوری‌ها
سکوها و فناوری‌های مرتبط
فهرست فناوری‌هایی که در این حوزه با آن‌ها کار می‌کنیم. انتخاب نهایی در مرحلهٔ طراحی و بر پایهٔ وضعیت موجود سازمان انجام می‌شود.
- Network Topology Diagrams
- Asset Inventory
- Runbooks
- Configuration Management
- Change Log
- Wiki / Knowledge Base
پرسش‌های متداول — مستندسازی و معماری
مستندات در چه قالبی تحویل داده می‌شود؟
در قالبی که سازمان شما بتواند خودش نگهداری و به‌روز کند. انتخاب قالب بخشی از گفت‌وگوی اولیه است و به ابزارهایی که تیم شما از آن‌ها استفاده می‌کند بستگی دارد. مستندات متعلق به سازمان شماست و بدون وابستگی به ما قابل استفاده است.
چطور جلوگیری می‌کنید که مستندات دوباره قدیمی شوند؟
با دو کار: محدود کردن دامنه به آنچه واقعاً استفاده می‌شود — مستندات حجیم زودتر رها می‌شوند — و تعریف چرخهٔ بازبینی سبک که به فرایند کار گره بخورد، نه یک کار جداگانهٔ فراموش‌شدنی.
آیا اطلاعات حساس مثل رمزها هم مستند می‌شود؟
اعتبارهای دسترسی در مستندات عمومی ثبت نمی‌شوند. مدیریت آن‌ها در سامانهٔ مخصوص نگهداری اعتبار با دسترسی کنترل‌شده انجام می‌گیرد و مستندات فقط به محل نگهداری و مالک آن ارجاع می‌دهند.
این خدمت را می‌توان جدا از سایر خدمات گرفت؟
بله. مستندسازی اغلب به‌عنوان یک پروژهٔ مستقل انجام می‌شود، به‌ویژه پیش از تغییر پیمانکار، ورود همکار جدید یا شروع یک پروژهٔ ارتقای بزرگ.
خدمات مرتبط
دربارهٔ مستندسازی و معماری در سازمان خود صحبت کنیم
در جلسهٔ تخصصی، وضعیت فعلی، محدودیت‌ها و اهداف قابل اندازه‌گیری شما بررسی می‌شود و تصویر روشنی از معماری پیشنهادی و مراحل اجرا ارائه می‌گردد.