Table of Contents
Các biểu đồ này bao gồm vô số tài liệu kỹ thuật, hướng dẫn xử lý và bản thiết kế kiến trúc. Chúng chưng cất các hệ thống phức tạp thành các câu chuyện trực quan có tiêu hóa. Tuy nhiên, khi hệ thống tiến hóa, các biểu đồ này cũng phải được tiến hóa. Việc sao chép các bản cập nhật đưa ra những lỗi chính xác, giảm thiểu giá trị, và sự tin tưởng bị xói mòn. Giữ biểu đồ ngăn không phải là một nhiệm vụ duy trì, nó đòi hỏi một cách tiếp cận có kỷ luật, tiếp tục diễn. Bài này sẽ vạch ra những chiến lược thực tế để giữ cho biểu đồ chính xác, rõ ràng, và hữu ích trong suốt thời gian dài.
Tại sao cập nhật đều đặn không thể truy cập được
Một biểu đồ ngăn phản ánh sự thất bại trong việc kiểm soát, vi phạm thời gian, và lãng phí thời gian. Các bản cập nhật thường xuyên đảm bảo rằng mỗi người giữ các mối quan hệ phụ thuộc - từ những nhà phát triển trẻ đến những người lập trình viên cấp độ cao có khả năng quyết định sai về các vật liệu có chung, và làm suy yếu các vật liệu tinh thần. Trong việc quản lý công nghiệp như chăm sóc y tế hoặc tài chính, việc kiểm toán có thể mời gọi sự sửa đổi theo thời gian hiện thời. Hơn nữa, các bản đồ đang tăng tốc, đơn giản hóa đơn giản hóa, đơn giản hóa và hỗ trợ êm đẹp giữa các nhóm quảng cáo cũ.
Xây dựng một hệ thống điều khiển phiên bản cho sơ đồ
Điều khiển phiên bản là xương sống của việc bảo trì biểu đồ bền vững. Không có nó, thay đổi trở thành hộp đen: không ai biết ai cập nhật điều gì, khi nào, hoặc tại sao. Cách điều khiển phiên bản âm thanh không cần thiết một phương pháp VCS dành riêng cho biểu đồ- nó có thể đơn giản như một hội nghị tên kết hợp với một kho chứa chung.
Nơi lưu trữ và theo dõi các thay đổi
Đối với các nhóm sử dụng tập tin mã bản đồ (vsdx, lưu trữ ) bên cạnh mã số. Ghi chú mỗi thay đổi, [FLT: 0]. Vẽ lại, vvsdx, vlcd [FLT: 1], bên cạnh các mã số [FL:]. g], [FT] ghi chú mỗi thay đổi, cung cấp các chi nhánh cho sơ đồ thử nghiệm. Hoặc, các công cụ sơ đồ dựa trên mây như [FLT:] Lucid [FT:] [F: FL] [FT] hoặc [F: T] vẽ]. [F3]. [F: Bản sửa đổi, bản sửa đổi, sửa đổi lịch sử trước đó dễ dàng hơn. Để xem xét lại các phiên bản.
Thay đổi bản ghi và chú giải
Bản ghi thay đổi không chỉ là một tập tin đổ; nó là một câu chuyện về lý do tại sao biểu đồ tiến hóa. Hãy dùng một tập tin đánh dấu nhỏ (hoặc trường mô tả của sơ đồ) để ghi lại mỗi trường đã được thêm hay gỡ bỏ: những khối nào được thêm vào hoặc gỡ bỏ, đường nào đã thay đổi, và đường nào đã thay đổi, và đường nào đã được thay đổi. Để ví dụ: [FLT: 0] [FL: 0] [FL: 0] [FT: 1] [FT1]], 20- 2003-15-15- 15- 15- 15- 15- 3: Thay thế cửa ra vào BAR BAR BAR bằng các cổng đồ giờ đã được gỡ bỏ ; bộ nhớ tạm [FL]. [FL:] [L]
Giữ cho ngôn ngữ thị giác rõ ràng và nhất quán
Khi mỗi biểu đồ khối sử dụng cùng một biểu tượng, màu sắc và quy tắc bố trí, độc giả ngay lập tức nắm bắt ý nghĩa mà không cần phải học lại ký hiệu.
Tạo một Hướng dẫn Kiểu dáng
Tạo một hướng dẫn kiểu dáng kiểu trang trí kiểu K để định nghĩa:
- Hình chữ nhật – e.g., hình chữ nhật cho dịch vụ, hình chữ nhật tròn cho diễn viên, kim cương cho quyết định.
- Bảng màu – dành màu đỏ cho các hệ thống bên ngoài, xanh lá cây cho bên trong, xanh cho các cửa hàng dữ liệu.
- Kiểu dáng – rắn cho các cuộc gọi đồng bộ, tiêu tan để aryncherous, dotted cho dữ liệu lưu.
- Font và kích cỡ ) – sử dụng một phông chữ sansSerif tại 10–12pt để đọc.
- Các hội nghị tự đặt ) — luôn luôn có tên khối và, cho biểu đồ phức tạp, mô tả ngắn.
Hãy phân phối hướng dẫn cho tất cả những người đóng góp và liên kết với mỗi biểu đồ siêu dữ liệu.
Đơn giản hóa mà không cần hy sinh chi tiết
Biểu đồ khối có thể trở nên lộn xộn khi cố gắng hiển thị mọi thứ cùng một lúc. Hãy chia các hệ thống lớn thành quan điểm phân cấp: một biểu đồ tổng quát cao kết nối với biểu đồ chi tiết nhỏ (v. d.: khả năng bảo tồn độ chính xác của mỗi lớp lớp trong khi ngăn cản một biểu đồ trở thành tường và các đường thẳng.
Kết hợp Phản hồi vào vòng nâng cấp
Biểu đồ chỉ tốt bằng thông tin chúng mã hóa. Những người xây dựng và vận hành hệ thống giữ những kiến thức mới nhất. Thiết lập thói quen để thu thập dữ liệu vào.
Vun trồng sự đáp trả không ngừng
Khuyến khích các thành viên trong nhóm gửi các lời khuyên hoặc sửa chữa qua một tiến trình đơn giản. Chẳng hạn, một kênh Slack đã hiến dâng hoặc một mẫu báo trong dự án của bạn. Hãy xem lại các sự đóng góp trong tuần hoặc tuần lễ. Không phải mọi gợi ý đều được chấp nhận, nhưng thừa nhận mỗi sự đóng góp tạo ra quyền sở hữu và bắt lỗi sớm.
Kiểm tra tự động khi có thể
Một số môi trường sơ đồ hỗ trợ các quy tắc hợp lệ cơ bản. Ví dụ, bạn có thể áp dụng rằng mỗi khối có nhãn và không có hai khối nào chia sẻ cùng tên. Trong khi hạn chế, những kiểm tra này bắt lỗi chung trước khi trình xem biểu đồ tới trình xem. Đối với nhu cầu cấp cao, tập tin gốc có thể phân tích các tập tin sơ đồ và so sánh tên khối đối với kho chứa hệ thống, đánh dấu hay phân loại thành phần bị thiếu.
Chọn các mục và mẫu bên phải
Công cụ bạn chọn tác động dễ dàng đến mức nào để thực hiện việc cập nhật và làm thế nào có thể bảo trì biểu đồ một cách nhất quán. Hãy đánh giá các tùy chọn dựa trên kích thước, nhu cầu hợp tác và sự kết hợp với luồng công việc đã có.
Các tùy chọn phần mềm được so sánh
- Microsoft Visio – Mạnh mẽ cho môi trường kinh doanh; hỗ trợ hình dạng và dữ liệu phức tạp liên kết. Tốt nhất là khi đa số thành viên nhóm nằm trên Windows.
- Lucidchart – Cloud llT:1] – Cloud lead, realtime compage, alarm hoods.
- Vẽ.io (diagrams.net) – opensources, hỗ trợ biên dịch ngoài và nhiều định dạng xuất khẩu. Làm việc với Git tốt vì nó tiết kiệm được XML thuần túy.
- PlantUML / Người Cá – thế hệ sơ đồ dựa trên văn bản. Lý tưởng cho các nhóm muốn phiên bản sơ đồ điều khiển bằng mã, nhưng ít nhìn lên trực quan hơn.
Không có công cụ nào là hoàn hảo cho mọi tình huống. Chọn một công cụ mà đội của bạn sẽ thực sự sử dụng; một công cụ ngồi không sử dụng còn tệ hơn một hình ảnh bảng trắng đơn giản. Một khi chọn, đầu tư thời gian vào việc tạo ra các mẫu có khả năng tái tạo mà nhúng hướng dẫn kiểu mẫu của bạn - điều này làm giảm rào chắn để bắt đầu một biểu đồ mới và thực thi tính thống nhất từ khối đầu tiên.
Bảo trì lâu năm: Xem lại, tài liệu và huấn luyện
Để giữ cho các sơ đồ luôn luôn xanh tươi qua nhiều năm, cần phải có nhiều sự cập nhật khác nhau, nhưng cần phải có một phương pháp có hệ thống được dệt thành nhịp điệu của đội.
Chương trình ôn lại đều đặn
Để có thể nhanh chóng di sản theo thứ tự, hãy hỏi:
- Có phải mỗi khối vẫn còn tồn tại trong sản xuất?
- Các kết nối (dữ liệu dòng chảy, phụ thuộc) vẫn còn đúng không?
- Có hội nghị nào thay đổi tên không?
- Có những thành phần mới nào cần được thêm vào không?
Tài liệu kết quả của mỗi bài đánh giá, ngay cả khi không cần thay đổi để chứng minh tính toán đúng mực.
Tài liệu thay đổi với khả năng truy vấn
Ngoài một bản ghi thay đổi, liên kết cập nhật biểu đồ tới các thay đổi riêng. Chẳng hạn, gắn biểu đồ vào một ghi chú thả ra hay một vé tính năng. Tính năng này giúp các thành viên mới hiểu tại sao một biểu đồ nhìn theo cách nó làm và cho phép các thính giả kiểm tra các tài liệu liên kết với hệ thống đã được triển khai. Hãy dùng những công cụ như [FLT: 0] Ghi chú [FLT: 1] hoặc Liên kết nhúng trực tiếp vào sơ đồ trong trang tài liệu, với một thiết bị điều khiển phiên bản cho thấy khi nó được cập nhật cuối cùng.
Thành viên của nhóm huấn luyện trong chương trình bảo trì biểu đồ
Không nên xây dựng sự hiểu biết về cách cập nhật sơ đồ. Hãy điều khiển một phiên chạy huấn luyện ngắn trên công cụ đã chọn, kiểu dáng và dòng cập nhật. Tạo một bộ hướng dẫn [FLT: 0] [FLT: 0] để giảm bớt nỗ lực của việc làm (FLT: 1) bao gồm những hành động thiết yếu ( dụng cụ, lưu, xuất khẩu, liên kết với tài liệu).
Cơ hội vô cơ hội tự động và cơ hội hợp nhất
Việc bảo trì bằng tay rất kém. Tìm cơ hội để tự động hóa phần của tiến trình cập nhật. Chẳng hạn, nếu bạn dùng cơ sở hạ tầng như mã, tập lệnh có thể phân tích các đường ống AWS CloudFormation hay Terraform bánh xe hơi và tạo một biểu đồ bản vẽ tự động. Trong khi sơ đồ tự động tạo cần sự đánh bóng của con người, chúng tiết kiệm giờ của vị trí thủ công. Việc tích hợp với các đường ống kiểu mẫu CN/C cũng có thể tạo một biểu đồ mới sau mỗi việc phóng, tạo sự trôi dạt giữa các cấu trúc và hệ thống chạy.
Thậm chí việc tự động hóa đơn giản hơn: sử dụng công cụ ADIs để thêm nhãn giờ hoặc phù hiệu phiên bản vào mỗi biểu đồ xuất khẩu, hoặc thiết lập một công việc cron để nhắc nhở khi chưa được chạm vào biểu đồ trong ba tháng.
Kết luận
Biểu đồ là những tài liệu sống. Không cố ý, chúng sẽ bị nhiễu. Bằng cách sử dụng phiên bản điều khiển, thực hiện sự nhất quán, bao gồm phản hồi, chọn cách dán và sửa đổi các mục tiêu, và đảm bảo các biểu đồ của mình thành thói quen của nhóm, bạn đảm bảo rằng biểu đồ vẫn là nguồn tin cậy của sự thật. Đầu tư nhỏ trong quá trình cập nhật sửa chữa trả lại trong ít sự hiểu lầm, ít khó khăn hơn, và tự tin hơn quyết định. Đối chiếu sơ đồ không phải là đồ của giai đoạn thiết kế, nhưng là tài sản tiến hóa cùng với hệ thống của bạn.