✨Thư viện tài liệu thực hành　Vui lòng tham khảo

Từ bản phác thảo đến tài liệu có giá trị 

Ví dụ lập tài liệu thiết kế・cấu hình mạng dành cho tổ chức tài chính 

Đây là ví dụ về cấu hình mạng giả định cho hệ thống ngân hàng. Sơ đồ này minh họa dễ hiểu cấu hình tổng thể bao gồm trụ sở chính・chi nhánh・phòng máy chủ・quản lý vận hành, đồng thời tổng hợp các điểm thiết kế như dự phòng, bảo mật, VPN, mạng LAN không dây, sao lưu, v.v.

Sơ đồ cấu hình hệ thống Ví dụ lập tài liệu 

Đây là ví dụ thiết kế kiến trúc tổng thể hệ thống. Đối với môi trường tại chỗ, AWS, Azure và đám mây lai, tài liệu này sơ đồ hóa một cách dễ hiểu từ cấu hình tổng thể hệ thống, cấu hình máy chủ logic, kết nối mạng đến các biện pháp bảo mật. Tài liệu đăng tải các ví dụ thiết kế có xem xét vai trò và mối liên hệ của từng thành phần cấu hình, tính sẵn sàng và khả năng vận hành, có thể được áp dụng cho thiết kế hệ thống đa dạng từ xác định yêu cầu đến thiết kế cơ bản.

Mạng Tập sơ đồ cấu hình Ví dụ lập tài liệu 

Đây là ví dụ lập sơ đồ cấu hình mạng.

Với chủ đề L2、L3、Firewall、VPN、Zero Trust, tài liệu này sơ đồ hóa một cách dễ hiểu các nội dung thiết kế như phân chia VLAN, kiểm soát tuyến đường, dự phòng, kiểm soát thông tin liên lạc, mã hóa, xác thực・quản lý truy cập, v.v. Tài liệu hệ thống hóa vai trò của từng thành phần cấu hình, đường truyền thông, phương pháp giám sát và các hạng mục cần xác nhận khi thiết kế; có thể được sử dụng làm tài liệu đề xuất mạng, tài liệu thiết kế cơ bản và tài liệu thiết kế cấu hình. 

Ví dụ lập tài liệu thiết kế DB・tích hợp API・thiết kế vận hành

Trang này giới thiệu các mẫu sơ đồ cấu hình và tài liệu thiết kế cần thiết từ phát triển hệ thống đến thiết kế vận hành, bao gồm thiết kế cơ sở dữ liệu, tích hợp API, chuyển trạng thái, vận hành batch/job, giám sát, khôi phục thảm họa và sao lưu. Đây là tài liệu thực tiễn có thể chỉnh sửa và tùy chỉnh theo yêu cầu nghiệp vụ và yêu cầu vận hành. 

Ví dụ lập kế hoạch chuyển đổi・chuyển mạch hệ thống

Đây là ví dụ lập kế hoạch hệ thống hóa từ lựa chọn phương thức chuyển đổi cần thiết cho việc thay đổi hệ thống, so sánh hệ thống hiện hành・hệ thống mới, chuyển đổi dữ liệu, diễn tập, chuyển mạch sản xuất, hoàn nguyên, phán định Go／No-Go, đến giám sát tập trung sau chuyển đổi. Không chỉ quy trình công việc, tài liệu còn làm rõ điều kiện bắt đầu・hoàn tất, người chịu trách nhiệm, tiêu chí phán định và bằng chứng; có thể được sử dụng làm kế hoạch chuyển đổi hoặc kế hoạch chuyển mạch.

Ví dụ lập sơ đồ cấu hình kiến trúc bảo mật

Đây là ví dụ lập tài liệu thiết kế sơ đồ hóa một cách dễ hiểu các nội dung như cấu hình Web・AP・DB, VMware・Hyper-V・Nutanix, SAN・NAS, Docker・Kubernetes, giám sát tích hợp, v.v., với chủ đề máy chủ, nền tảng ảo hóa, lưu trữ, container và giám sát. Tài liệu hệ thống hóa đường truyền thông, dự phòng, bảo vệ dữ liệu, đường quản lý, phương pháp giám sát và hoạt động khi xảy ra sự cố; có thể được sử dụng làm tài liệu đề xuất hạ tầng, tài liệu thiết kế cơ bản và tài liệu thiết kế cấu hình.

Sơ đồ kiến trúc hạ tầng 

Đây là ví dụ về tài liệu thiết kế minh họa rõ ràng kiến trúc máy chủ, nền tảng ảo hóa, lưu trữ, container và giám sát, bao gồm cấu hình Web/AP/DB, VMware, Hyper-V, Nutanix, SAN/NAS, Docker, Kubernetes và giám sát tích hợp. Tài liệu trình bày đường truyền thông, cấu hình dự phòng, bảo vệ dữ liệu, đường quản trị, phương pháp giám sát và hoạt động khi xảy ra sự cố; có thể sử dụng làm tài liệu đề xuất hạ tầng, tài liệu thiết kế cơ bản và tài liệu thiết kế cấu hình. 

Sơ đồ kiến trúc ứng dụng・thiết kế phát triển

Đây là ví dụ lập tài liệu thiết kế phát triển sơ đồ hóa một cách dễ hiểu cấu hình tổng thể ứng dụng, 3 tầng・MVC, thành phần, vi dịch vụ, trình tự, tích hợp sự kiện・thông điệp, xác thực・quyền hạn, xử lý ngoại lệ, v.v. Tài liệu hệ thống hóa vai trò theo từng chức năng, quan hệ phụ thuộc, trình tự xử lý, luồng dữ liệu, hoạt động khi xảy ra sự cố và các hạng mục cần xác nhận khi thiết kế; có thể được sử dụng làm tài liệu thiết kế cơ bản, tài liệu thiết kế ứng dụng và tài liệu đặc tả phát triển.

Ví dụ lập tài liệu đề xuất thay đổi hệ thống

Đây là ví dụ lập tài liệu đề xuất tổng hợp các vấn đề như sự lão hóa của hệ thống, thời hạn bảo trì, thiếu hiệu năng, bảo mật, tải vận hành, v.v., cùng với phương châm thay đổi, cấu hình hệ thống mới, kế hoạch chuyển đổi・chuyển mạch, lịch triển khai, cơ cấu thực hiện, chi phí ước tính và hiệu quả triển khai. Tài liệu trình bày dễ hiểu sự khác biệt giữa hệ thống hiện hành và sau thay đổi, cũng như dự phòng, giám sát, sao lưu và phương pháp chuyển đổi an toàn; có thể được sử dụng làm tài liệu đề xuất cho việc thay đổi hệ thống hoặc đổi mới nền tảng.

Ví dụ lập tài liệu kế hoạch kiểm thử・quản lý chất lượng

Đây là ví dụ lập tài liệu kế hoạch kiểm thử・quản lý chất lượng, hệ thống hóa từ kiểm thử đơn vị・tích hợp・tổng thể・kịch bản nghiệp vụ・tải hiệu năng・phục hồi sự cố・bảo mật・nghiệm thu người dùng. Tài liệu làm rõ phạm vi kiểm thử, tiêu chí bắt đầu・kết thúc, chỉ số chất lượng, quản lý lỗi, bằng chứng kiểm thử, rủi ro còn lại và điều kiện phán định có thể phát hành hay không; có thể được sử dụng làm kế hoạch kiểm thử, kế hoạch quản lý chất lượng và tài liệu phán định nghiệm thu・hoàn tất.

Ví dụ lập tài liệu thiết kế màn hình・UI/UX

Đây là ví dụ lập tài liệu thiết kế màn hình・UI/UX, trong đó danh sách màn hình・cấu trúc thông tin, chuyển màn hình, wireframe, kiểm tra đầu vào, hiển thị theo quyền hạn, thông báo lỗi, hỗ trợ responsive, khả năng truy cập, hành trình người dùng, v.v. được sắp xếp dễ hiểu. Luồng thao tác giúp người dùng đạt được mục tiêu mà không bị lúng túng, cũng như các hạng mục cần xác nhận và tiêu chí nghiệm thu trong thiết kế・triển khai・xác minh người dùng được làm rõ, và có thể được sử dụng làm tài liệu thiết kế màn hình, tài liệu thiết kế UI/UX và tài liệu đặc tả phát triển.

Ví dụ lập tài liệu xác định yêu cầu・thiết kế nghiệp vụ

Đây là ví dụ lập tài liệu sắp xếp một cách có hệ thống từ bối cảnh・mục đích tin học hóa, phạm vi đối tượng・các bên liên quan, luồng nghiệp vụ hiện hành・mới, các vấn đề nghiệp vụ và chính sách cải thiện, yêu cầu chức năng・phi chức năng・bảo mật, đến yêu cầu dữ liệu・liên kết bên ngoài. Với cấu trúc liên kết các vấn đề nghiệp vụ và KPI, yêu cầu, thiết kế, kiểm thử, tiêu chí phê duyệt, giúp thống nhất nhận thức giữa các bên liên quan, tài liệu này có thể được sử dụng làm tài liệu xác định yêu cầu, tài liệu thiết kế nghiệp vụ và tài liệu kế hoạch tin học hóa.

Ví dụ lập tiêu chuẩn phát triển phần mềm・quy ước lập trình

Đây là ví dụ lập tài liệu đặc tả giao diện cần thiết cho liên kết API. Tài liệu tổng hợp dễ hiểu các hạng mục thiết kế cần thiết ở cấp độ triển khai, từ endpoint, request・response, xác thực・phân quyền, xử lý lỗi, kiểm soát gửi lại, transaction, đến giám sát・vận hành. Có thể chỉnh sửa・tùy chỉnh nguyên trạng để sử dụng làm tài liệu thiết kế chi tiết・rà soát cho REST API và liên kết giữa các hệ thống.

Mẫu tài liệu thiết kế chi tiết API và đặc tả giao diện 

Đây là ví dụ về tài liệu đặc tả giao diện cần thiết cho tích hợp API. Tài liệu trình bày rõ ràng các hạng mục thiết kế ở cấp độ triển khai, bao gồm endpoint, request/response, xác thực và phân quyền, xử lý lỗi, kiểm soát gửi lại, giao dịch, giám sát và vận hành. Có thể chỉnh sửa và tùy chỉnh để sử dụng làm tài liệu thiết kế chi tiết và tài liệu rà soát cho REST API cũng như tích hợp giữa các hệ thống. 

Ví dụ lập tài liệu thiết kế phát hành・quản lý cấu hình

Đây là ví dụ lập tài liệu sắp xếp một cách có hệ thống từ tài sản phát triển, cấu hình môi trường, phiên bản, thay đổi, phê duyệt, triển khai môi trường sản xuất, hoàn tác, đến giám sát sau phát hành. Có thể được sử dụng để quản lý tập trung thông tin cấu hình và lịch sử công việc, phát hành an toàn, chắc chắn và theo dõi thay đổi.

Ví dụ lập tài liệu thiết kế quản lý vận hành・bảo trì 

Đây là ví dụ lập tài liệu sắp xếp một cách có hệ thống về giám sát, xử lý sự cố・yêu cầu hỗ trợ, công việc định kỳ, quản lý job, sao lưu, quản lý thay đổi, bảo trì, SLA, v.v. Có thể được sử dụng cho vận hành hệ thống ổn định, xử lý sự cố nhanh chóng và cải thiện liên tục chất lượng vận hành.

Ví dụ lập tài liệu thiết kế chi tiết・đặc tả chương trình

Đây là ví dụ lập tài liệu cụ thể hóa từ cấu trúc hệ thống・mô-đun, chức năng・lớp・thành phần, luồng xử lý, mapping đầu vào/đầu ra・hạng mục, xử lý DB・transaction・kiểm soát độc quyền, liên kết API・hệ thống bên ngoài, đến thiết kế lỗi・log・chạy lại. Nội dung thiết kế cơ bản được sắp xếp ở mức độ chi tiết có thể chuyển giao sang triển khai・kiểm thử đơn vị, đồng thời làm rõ mối quan hệ tương ứng giữa thiết kế và kiểm thử cũng như tiêu chí rà soát・hoàn thành; có thể được sử dụng làm tài liệu thiết kế chi tiết, tài liệu đặc tả chương trình và tài liệu đặc tả kiểm thử đơn vị.

Vui lòng liên hệ tại đây nếu có thắc mắc.