Tec Nikan
English
تماس با ما
All posts

بسته تحویلی که واقعا به کار می‌آید

بیشتر مستندات چون‌ساخت برای برآورده کردن بندی از قرارداد نوشته می‌شوند و کسی نمی‌خواندشان. مقدار کمی از آن، اگر جور دیگری نوشته شود، همان است که تکنسین ساعت سه بامداد بازش می‌کند.

مستندسازیتحویلچون‌ساختنگهداشتاجرای پروژه

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

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

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

پس آن چیز کوچک را عامدانه بنویسید، و به جای یادداشت خصوصی کسی، تحویل‌شدنی بدانیدش. آنچه باید داشته باشد در پروژه‌ها نسبتا یکسان است. یک نمای یک‌صفحه‌ای از سامانه که به همان شکلی کشیده شده که سامانه واقعا رفتار می‌کند، نه به شکلی که خریداری شده — جعبه، فلش، پروتکل، جهت جریان. جدول نشانی و هویت: هر دستگاه، نشانی شبکه‌اش، نامش در اسکادا، محل فیزیکی‌اش، نگارش فریمورش هنگام تحویل. ترتیب اعتبارنامه‌ها، یعنی اینکه اعتبارنامه‌ها کجا نگه داشته می‌شوند و چه کسی می‌تواند بگیردشان، نه خود اعتبارنامه‌ها. اینکه عادی چه شکلی است: مقادیر معمول، نرخ‌های معمول، معنای چراغ‌های نشانگر. سه چهار حالت خرابی‌ای که تیم پروژه از پیش می‌شناسد، با نشانه‌های‌شان — هر پروژه‌ای اینها را دارد و تا وقتی آن آدم‌ها بروند در سر آدم‌ها زندگی می‌کنند. و مسیر ارجاع، با نام و ساعت.

دو ویژگی بیش از کامل بودن اهمیت دارند. باید یافتنی باشد — در اتاق کنترل، روی شبکه‌ای که پشتیبانی به آن می‌رسد، و جایی که عملی است از نظر فیزیکی درون خود تابلو. یک برگه لمینت‌شده پشت در کابینت بیش از هر سامانه مدیریت سندی از توقف جلوگیری کرده است. و باید به‌روز باشد، که بخش دشوار است.

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

یک آزمون می‌گوید تحویل کار کرده یا نه. شش ماه پس از آغاز بهره‌برداری، خطایی باورپذیر را به تکنسینی بدهید که سامانه را نساخته و ببینید اول چه چیزی را باز می‌کند. اگر پوشه بود، بسته خوب نوشته شده. اگر تلفن بود، نه — و کسی که به او زنگ می‌زند نقطه خرابی منفردی است که پروژه ساخت و جا گذاشت.

Want to work with us?

Tell us what you're building and we'll help you scope the first deployment.