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

چرا به روز رسانی های منظم غیر قابل مذاکره هستند

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

ساخت یک سیستم کنترل نسخه برای Diagrams

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

کجا ذخیره و پیگیری تغییرات

برای تیم های استفاده از Git، ذخیره فایل های منبع نمودار (به عنوان مثال، [FLT] [FLT]، [FLT]، [FLT:LT]، [FLT] را در هر تغییر، یک نشانه اختصاصی را ارائه می دهد و اجازه می دهد تا برای نمودارهای تجربی، جایگزین، ابزار نمودار مبتنی بر ابر مانند [F] ویرایش [F] [F] [p] [F] [p] [F] که هر کدام از آنها را انتخاب می کنند، یک از طریق یک از نسخه های ساده و یا یک از آن را انتخاب کنید.

تغییر و Annotations

یک فایل تغییر فقط یک فایل نیست؛ یک روایت از اینکه چرا نمودار تکامل یافته است، استفاده از یک فایل علامت گذاری سبک (یا فیلد توصیف نمودار) برای ثبت هر بازبینی است: چه بلوک هایی اضافه شده یا حذف شده است، که خطوط تغییر کرده و منطق:
[FLT: نمودار 125] - 15 - در طول زمان تأخیر در لایه ذخیره سازی لایه جدید نیاز به حذف و حذف شدن دارند.

حفظ زبان بصری شفاف و مداوم

سازگاری باعث کاهش بار شناختی می شود، هنگامی که هر نمودار بلوک از همان نمادها، رنگ ها و قوانین طرح استفاده می کند، خوانندگان بلافاصله بدون یادگیری مجدد معنی را درک می کنند. Inconsistency، از سوی دیگر، نژادها تفسیر نادرست.

راهنمای سبک را ایجاد کنید

یک راهنمای سبک یک صفحه ای ایجاد کنید که تعریف می کند:

  • اشکال را به عنوان مثال، مستطیل برای خدمات، مستطیل گرد برای بازیگران، الماس برای تصمیم گیری.
  • پالت رنگی - ذخیره قرمز برای سیستم های خارجی، سبز برای داخلی، آبی برای فروشگاه های داده.
  • سبک های خط - جامد برای تماس های ناهمزمان، برای ناهمگونی، برای جریان داده ها.
  • (فَهُوَهُمَهُمَهُمَهُمَهُمَهُمَهُمَهُمَهُمَهُمَهُوا بِهَهُمَهُمَهُمْهُمَهُمَهُمَهُمَهُهُهُمَهُهُهُمَهُهُهُهُهُهُهُهُهُهُهُهُهُهُهُهُهُهُهُوَهُهُهُهُهُمَهُهُهُوَهُهُهُهُهُهُهُهُهُهُهُهُمَهُهُهُهُهُمَهُهُهُوَهُهُهُهُهُهُهُهُهُهُوَهُوَهُهُهُهُهُهُوَهُهُهُوَهُهُ
  • کنوانسیون های انعقاد - همیشه شامل یک نام بلوک و برای نمودارهای پیچیده، شرح کوتاه است.

توزیع راهنمای همه مشارکت کنندگان و شامل یک لینک در متاداده هر نمودار.بررسی منظم از راهنما آن را با قابلیت های ابزار در حال تحول یا ترجیحات تیم هماهنگ نگه می دارد.

ساده سازی بدون جزئیات

نمودارهای بلوک می توانند به هم ریخته شوند زمانی که سعی می کنند همه چیز را در یک زمان نشان دهند. شکستن سیستم های بزرگ به دیدگاه های سلسله مراتبی: یک نمودار کلی سطح بالا به نمودارهای جزئیات سطح پایین (به عنوان مثال، " لایه ی یکپارچه" گسترش می یابد به یک زیرگرمی از ظروف و تعادل بار) استفاده از ارجاعات یا لینک های عددی (در دیجیتال) برای حرکت دادن به لایه ها و جلوگیری از دقت یک جعبه ها در حالی که از یک لایه ی دیوار جلوگیری می کنند.

بازخورد شرکت در چرخه به روز رسانی

دیگرام ها تنها به اندازه اطلاعاتی که کد می کنند خوب هستند.افرادی که سیستم را می سازند و کار می کنند، تازه ترین دانش را در اختیار دارند.

فاستر فرهنگ بازخورد مستمر

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

اعتبار خودکار در صورت امکان

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

ابزار و قالب های مناسب را انتخاب کنید

ابزار شما را انتخاب کنید که چگونه به روز رسانی آسان می تواند ساخته شده و چگونه به طور مداوم نمودار حفظ شده است. ارزیابی گزینه های بر اساس اندازه تیم، نیازهای همکاری و ادغام با جریان های کاری موجود.

گزینه های نرم افزار در مقایسه

  • Microsoft Visio - قدرتمند برای محیط های سازمانی؛ پشتیبانی از اشکال پیچیده و لینک داده ها بهترین زمانی که اکثر اعضای تیم در ویندوز هستند.
  • [FLT 1 ] [FLT 1 ] - Cloud-first ، همکاری زمان واقعی ، کتابخانه های شکل گسترده با Confluence و Jira برای جریان های کاری اسناد ادغام می شوند.
  • [diagrams.net] - Free، open source، ویرایش آفلاین و بسیاری از فرمت های صادراتی به خوبی با Git کار می کند، زیرا در XML خالص ذخیره می شود.
  • [برنامه ریزی شده] / دریایی [FLT 1] - نسل نمودار مبتنی بر متن ایده آل برای تیم هایی که می خواهند نمودار های کنترل نسخه را به عنوان کد، اما کمتر بصری جلو.

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

نگهداری طولانی مدت: بررسی، مستندات و آموزش

نگه داشتن نمودارها در طول سال ها بیش از به روز رسانی های ad-hoc نیاز دارد، که یک رویکرد سیستماتیک در ریتم های تیم بافته شده است.

بررسی منظم

یادآوری تقویم تکراری را برای بررسی هر نمودار تنظیم کنید.این فرکانس بستگی به نرخ تغییر سیستم دارد.برای یک معماری میکروسرویس های سریع، هر دو هفته ممکن است مناسب باشد؛ برای یک سیستم میراث پایدار، سه ماهه ممکن است در طول یک بررسی، درخواست کنید:

  • آیا هر بلوک هنوز در تولید وجود دارد؟
  • آیا ارتباطات (جریان داده ها، وابستگی ها) هنوز درست هستند؟
  • آیا هیچ گونه کنوانسیون نام گذاری تغییر کرده است؟
  • آیا اجزای جدیدی وجود دارد که باید اضافه شوند؟

نتیجه هر بررسی را مستند کنید – حتی اگر هیچ تغییری لازم نبود – برای اثبات تلاش برای حسابرسی.

تغییرات مستند با قابلیت ردیابی

فراتر از یک log تغییر ساده، به روز رسانی نمودار لینک به تغییرات سیستم خاص. [برای مثال، نسخه نمودار را به یک یادداشت انتشار یا یک بلیط ویژگی متصل کنید] این قابلیت ردیابی به اعضای تیم جدید کمک می کند تا درک کنند که چرا یک نمودار به نظر می رسد راه آن را انجام می دهد و اجازه می دهد تا حسابرسان تأیید کنند که اسناد با سیستم های کاربردی سازگار هستند.استفاده از ابزارهایی مانند Notion [F]

آموزش اعضای تیم در Diagram Maintenance

دانش چگونگی به روز رسانی نمودارها نباید یک جلسه آموزش کوتاه در ابزار انتخاب شده، راهنمای سبک و گردش کار به روز رسانی ایجاد یک راهنمای شروع (FLT:0quick) را انجام دهد [FLT 1 که اقدامات ضروری را پوشش می دهد (اضافه کردن بلوک ها، پس انداز، توزیع، پیوند به مستندات).

فرصت های اتوماسیون و یکپارچه سازی

مقیاس های تعمیر دستی ضعیف است.به دنبال فرصت هایی برای خودکارسازی بخش هایی از فرآیند به روز رسانی باشید.برای مثال، اگر از زیرساخت به عنوان کد استفاده کنید، اسکریپت ها می توانند فایل های CloudFormation AWS یا فایل های دولتی Terraform را تجزیه و تحلیل کنند و یک نمودار به طور خودکار تولید کنند، در حالی که نمودارهای خودکار تولید شده اغلب به صورت خودکار نیاز به خودکار انسان دارند، ساعت های قرار دادن بلوک دستی را ذخیره می کنند.

حتی اتوماسیون ساده تر کمک می کند: از API های ابزار برای اضافه کردن یک برچسب زمان بندی یا نسخه به هر نمودار صادر شده استفاده کنید یا یک کار cron ایجاد کنید که یک یادآوری را هنگامی که یک نمودار در سه ماه لمس نشده است، ارسال می کند.

نتیجه گیری

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