Kanban
Biểu đồ kanban Mermaid cho phép bạn tạo biểu diễn trực quan về việc tác vụ luân chuyển qua các giai đoạn khác nhau trong quy trình làm việc, phần dưới đây giải thích cách sử dụng đúng cú pháp biểu đồ kanban.
Cơ bản
Biểu đồ kanban bắt đầu bằng cú pháp kanban, rồi định nghĩa các cột và các tác vụ trong các cột đó.
Sao chép
Nhúng
kanban
column1[Column Title]
task1[Task Description]
Định nghĩa cột
Cột biểu diễn các giai đoạn khác nhau trong quy trình làm việc, ví dụ "Việc cần làm", "Đang thực hiện", "Đã hoàn thành", v.v. Mỗi cột được định nghĩa bằng một mã định danh duy nhất và tiêu đề được bao quanh bằng dấu ngoặc vuông.
Cú pháp:
Sao chép
Nhúng
columnId[Column Title]
- columnId: mã định danh duy nhất của cột.
- [Column Title]: tiêu đề hiển thị ở đầu cột.
比如 id1[Todo]
Thêm tác vụ vào cột
Các tác vụ được hiển thị theo cột tương ứng, kèm theo thụt lề. Mỗi tác vụ bao gồm một mã định danh duy nhất và mô tả được bao quanh bằng dấu ngoặc vuông.
Cú pháp:
Sao chép
Nhúng
taskId[Task Description]
taskId: mã định danh duy nhất của tác vụ.,[Task Description]: mô tả của tác vụ.
Ví dụ:
Sao chép
Nhúng
docs[Create Documentation]
Thêm siêu dữ liệu vào tác vụ
Bạn có thể dùng cú pháp @{ ... } để thêm siêu dữ liệu bổ sung cho mỗi tác vụ. Siêu dữ liệu có thể chứa các cặp khóa-giá trị như assigned, ticket, priority, v.v., những thông tin này sẽ hiển thị trong quá trình kết xuất nút.
Các khóa siêu dữ liệu được hỗ trợ
Giao cho: chỉ định ai chịu trách nhiệm cho tác vụ đó.,Ticket: liên kết tác vụ với ticket hoặc số vấn đề.,Mức ưu tiên: biểu thị mức độ khẩn cấp của tác vụ. Các giá trị được phép: rất cao, cao, thấp và rất thấp.
Sao chép
Nhúng
kanban
todo[Todo]
id3[Update Database Function]@{ ticket: MC-2037, assigned: 'knsv', priority: 'High' }
Tùy chọn cấu hình
Bạn có thể dùng khối cấu hình ở đầu tệp markdown để tùy chỉnh biểu đồ kanban. Điều này hữu ích để thiết lập các cài đặt toàn cục (như URL cơ sở của ticket). Hiện tại, biểu đồ kanban <code>ticketBaseUrl</code> điều này rất hữu ích để thiết lập các cài đặt toàn cục, ví dụ URL cơ sở của ticket. Hiện tại biểu đồ kanban có một tùy chọn cấu hình là ticketBaseUrl. Có thể thiết lập theo ví dụ dưới đây:
Sao chép
Nhúng
---
config:
kanban:
ticketBaseUrl: 'https://yourproject.atlassian.net/browse/#TICKET#'
---
Khi mục kanban có số ticket được chỉ định, số ticket trong biểu đồ sẽ chứa một liên kết trỏ tới hệ thống bên ngoài định nghĩa ticket đó. ticketBaseUrl thiết lập URL cơ sở trỏ tới hệ thống bên ngoài, còn #TICKET# sẽ được thay bằng giá trị ticket trong siêu dữ liệu tác vụ, để tạo liên kết hợp lệ.
Ví dụ đầy đủ
Dưới đây là một ví dụ mã biểu đồ kanban đầy đủ:
Sao chép
Nhúng
---
config:
kanban:
ticketBaseUrl: 'https://mermaidchart.atlassian.net/browse/#TICKET#'
---
kanban
Todo
[Create Documentation]
docs[Create Blog about the new diagram]
[In progress]
id6[Create renderer so that it works in all cases. We also add some extra text here for testing purposes. And some more just for the extra flare.]
id9[Ready for deploy]
id8[Design grammar]@{ assigned: 'knsv' }
id10[Ready for test]
id4[Create parsing tests]@{ ticket: MC-2038, assigned: 'K.Sveidqvist', priority: 'High' }
id66[last item]@{ priority: 'Very Low', assigned: 'knsv' }
id11[Done]
id5[define getData]
id2[Title of diagram is more than 100 chars when user duplicates diagram with 100 char]@{ ticket: MC-2036, priority: 'Very High'}
id3[Update DB function]@{ ticket: MC-2037, assigned: knsv, priority: 'High' }
id12[Can't reproduce]
id3[Weird flickering in Firefox]
Tóm lại, tạo biểu đồ kanban trong Mermaid là một quá trình đơn giản, có thể trực quan hóa quy trình làm việc của bạn một cách hiệu quả.
Bạn có thể dùng cú pháp @{ ... } để thêm siêu dữ liệu tùy chọn vào tác vụ nhằm nâng cao biểu đồ của bạn, cú pháp này cho phép bạn bao gồm thông tin ngữ cảnh bổ sung, như người chịu trách nhiệm, số ticket và mức ưu tiên. Để tùy chỉnh sâu hơn, hãy dùng khối cấu hình ở đầu tệp để thiết lập các tùy chọn toàn cục, ví dụ ticketBaseUrl, để liên kết ticket trực tiếp từ biểu đồ.
Bằng cách tuân theo các hướng dẫn này, đảm bảo mã định danh duy nhất, thụt lề đúng, và tận dụng siêu dữ liệu cùng các tùy chọn cấu hình, bạn có thể tạo một biểu đồ kanban toàn diện và tùy biến, phản ánh hiệu quả quy trình làm việc của dự án.
