Bảng Kanban là một công cụ quản lý quy trình trực quan được sử dụng để theo dõi các nhiệm vụ hoặc mục công việc qua các giai đoạn xử lý khác nhau (như Danh sách chờ, Đang thực hiện và Đã hoàn thành). Được giới thiệu như một tính năng tích hợp sẵn trong Mermaid.js, cách tiếp cận dựa trên văn bản này cho phép các đội phát triển và quản lý dự án nhanh chóng tạo bảng điều khiển nhiệm vụ tương tác bên trong các tệp tài liệu mà không cần quản lý các ứng dụng theo dõi thủ công hay các thành phần hình ảnh từ bên thứ ba.
Cấu trúc cú pháp cơ bản
Mỗi bảng Kanban bắt đầu bằng kanbantiêu đề khai báo. Các cột được định nghĩa bằng cách sử dụng sectiontừ khóa, và các thẻ nhiệm vụ riêng lẻ được liệt kê theo thứ tự ngay dưới mỗi cột bằng cách sử dụng các khối khoảng cách thụt đầu dòng.
kanban
title "Sprint Dự án Mẫu"
section Chưa làm
Thiết kế sơ đồ cơ sở dữ liệu
Soạn thảo các tuyến API
section Đang thực hiện
Triển khai middleware xác thực
Tham chiếu cú pháp
Bảng dưới đây phân tích các thành phần dữ liệu nền tảng và tham số được sử dụng để xây dựng bản đồ bảng Kanban trong Mermaid.js.
| Thành phần cú pháp | Yêu cầu kiểu dữ liệu | Mô tả và quy tắc sử dụng |
|---|---|---|
| Khai báo | Chỉ định từ khóa | Khởi tạo các tham số ánh xạ khối quy trình linh hoạt. Phải sử dụng chính xác kanbankhối. |
| Tiêu đề | Chuỗi được đóng dấu ngoặc kép | Tiêu đề không bắt buộc cho không gian làm việc toàn cục, được căn giữa gọn gàng ở đầu bảng Kanban. |
| Cột phần | Từ khóa + Tên | Xác định một cột giai đoạn quy trình độc lập. Sử dụng từ khóa sectiontheo sau là nhãn của cột. |
| Thẻ nhiệm vụ tiêu chuẩn | Chuỗi thụt đầu dòng | Mô tả văn bản thuần túy đại diện cho một thẻ duy nhất. Nó phải được thụt đầu dòng hoặc thụt lề trực tiếp dưới phần đang hoạt động của nó. |
| Thẻ nhiệm vụ ID | Chỉ mục trong dấu ngoặc vuông | Một định dạng theo dõi thẻ nhiệm vụ nâng cao sử dụng một mã ID duy nhất rõ ràng cùng với nhãn hiển thị của nó: id[Text Thẻ]. |
| Khối dữ liệu phụ | Bản đồ cấu hình JSON | Một khối thuộc tính tùy chọn được thêm vào bằng cách sử dụng cú pháp @{...} quy tắc cú pháp để gán các thuộc tính như mức độ ưu tiên vé hoặc người sở hữu. |
Thuộc tính nhiệm vụ nâng cao và dữ liệu phụ
Đối với các đợt phát triển kỹ thuật chi tiết hoặc quy trình theo dõi lỗi, bạn có thể gán các thuộc tính dữ liệu phụ trực tiếp lên thẻ. Bằng cách kết hợp ID nút duy nhất (ví dụ như task1[...]) với một khối khai báo cấu hình JSON ở cuối (@{}), bạn có thể in các biến có cấu trúc như người được giao nhiệm vụ, mức độ ưu tiên và vé theo dõi nội bộ trực tiếp trên mặt của phần tử thẻ.
Các biến nhiệm vụ được hỗ trợ
| Khóa thuộc tính | Định dạng giá trị | Kết quả trực quan |
|---|---|---|
được giao |
Chuỗi tên trong dấu ngoặc kép | Hiển thị nhãn chủ sở hữu hoặc nhà phát triển được giao trực tiếp bên trong ma trận chi tiết thẻ. |
ưu tiên |
Chuỗi thang điểm trong dấu ngoặc kép | Hiển thị ngưỡng mức độ nghiêm trọng của nhiệm vụ (ví dụ như 'Cao', 'Trung bình', 'Thấp'). |
vé |
Token số nguyên hoặc chữ cái | Theo dõi các số nhiệm vụ phát triển liên kết hoặc mã dự án hệ thống. |
Bản thiết kế thực tế: Đợt phát hành phát triển linh hoạt
Bản thiết kế toàn diện này theo dõi một đợt phát hành triển khai cơ sở hạ tầng. Nó xác định ba cột riêng biệt (Danh sách chờ, Đang thực hiện và Sẵn sàng triển khai) và sử dụng các ID nhiệm vụ nâng cao kết hợp với các tham số siêu dữ liệu cấu trúc để gán các nhà phát triển cụ thể và mã vé cho các tính năng khác nhau.
kanban
title "Bảng phát hành tính năng cốt lõi Q3"
section Danh sách chờ
task101[Tạo tài liệu API Endpoint]@{ assigned: 'Sarah K', priority: 'Trung bình' }
task102[Thiết kế bản phác họa trang đích]
section Đang thực hiện
task201[Tinh chỉnh đồng bộ truy vấn cơ sở dữ liệu]@{ assigned: 'Alex M', priority: 'Cao', ticket: 4012 }
task202[Cấu hình các thành phần giao diện người dùng Lightbox]@{ assigned: 'Sarah K', priority: 'Thấp' }
section Sẵn sàng triển khai
task301[Thực hiện xác thực người dùng đa yếu tố]@{ assigned: 'Đội Dev', ticket: 3985 }
Lưu ý cú pháp: Trong khi các nhiệm vụ đơn giản có thể được gõ trực tiếp dưới dạng dòng văn bản thuần túy không dấu ngoặc kép, các gán nhiệm vụ phức tạp mang theo tham số siêu dữ liệu *phải* sử dụng tiền tố chuỗi ánh xạ ID duy nhất (ví dụ nhưid1[...]@{...}). Việc tái sử dụng chính xác cùng một ID nhiệm vụ ở các phần khác nhau trên bảng sẽ ghi đè thuộc tính hoặc gây lỗi bố cục.
Những lỗi cú pháp phổ biến và giới hạn hệ thống
Khi thiết kế các hệ thống bố cục phức tạp, nhiều giai đoạn, hãy lưu ý những tham số khắc phục sự cố cấu trúc sau:
- Quy tắc Cột trước Thẻ: Tất cả các thẻ nhiệm vụ phải nằm dưới khối cột đang hoạt động. Viết dòng chuỗi nhiệm vụ ngay dưới tiêu đề chính của bạn
kanbantiêu đề mà không khai báo mộtsectiontiêu đề cột đầu tiên sẽ làm dừng quá trình biên dịch. - Khoảng trắng và thụt lề: Bộ động lực bố cục theo dõi nhóm các thẻ dựa trên dấu thụt lề dòng. Đảm bảo tất cả các hàng thẻ nhiệm vụ đều được thụt lề đều đặn dưới các thẻ
sectionđể tránh lỗi căn chỉnh. - Định dạng Delimiter Metadata: Khi xây dựng các thuộc tính tùy chỉnh bên trong một
@{ }khối, các khóa và giá trị phải ánh xạ đến các đối số hệ thống hợp lệ. Tách các thuộc tính nhiều bằng dấu phẩy và sử dụng dấu ngoặc kép sạch để bao quanh các gán chuỗi của bạn. - Quản lý Mật độ Thẻ: Mặc dù thành phần Kanban hoàn toàn phản hồi, nhưng việc làm chật chội một bảng duy nhất với hơn 5 cột hoặc thêm hàng chục hàng metadata dày đặc có thể làm giảm khả năng quét trên di động. Hãy cân bằng các quy tắc khoảng cách bố cục một cách có chủ ý.