Diagram Kanban
Diagram kanban w Mermaid pozwala tworzyć wizualną reprezentację przepływu zadań przez różne etapy procesu roboczego; poniżej wyjaśniono, jak prawidłowo używać składni diagramu kanban.
Podstawy
Diagram kanban zaczyna się od składni kanban, a następnie definiuje kolumny i zadania w tych kolumnach.
Kopiuj
Osadź
kanban
column1[Column Title]
task1[Task Description]
Definiowanie kolumn
Kolumny reprezentują różne etapy procesu roboczego, na przykład "Do zrobienia", "W toku", "Ukończone" itp. Każda kolumna jest definiowana za pomocą unikalnego identyfikatora i tytułu ujętego w nawiasy kwadratowe.
Składnia:
Kopiuj
Osadź
columnId[Column Title]
- columnId: unikalny identyfikator kolumny.
- [Column Title]: tytuł wyświetlany w nagłówku kolumny.
比如 id1[Todo]
Dodawanie zadań do kolumny
Zadania są wyświetlane w odpowiednich kolumnach z wcięciem. Każde zadanie zawiera unikalny identyfikator i opis ujęty w nawiasy kwadratowe.
Składnia:
Kopiuj
Osadź
taskId[Task Description]
taskId: unikalny identyfikator zadania.,[Task Description]: opis zadania.
Przykład:
Kopiuj
Osadź
docs[Create Documentation]
Dodawanie metadanych do zadania
Możesz użyć składni @{ ... }, aby dodać dodatkowe metadane do każdego zadania. Metadane mogą zawierać pary klucz-wartość, takie jak assigned, ticket, priority, które zostaną wyświetlone w renderowaniu węzła.
Obsługiwane klucze metadanych
assigned: określa, kto jest odpowiedzialny za zadanie.,ticket: łączy zadanie ze zgłoszeniem lub numerem problemu.,priority: wskazuje pilność zadania. Dozwolone wartości: bardzo wysoki, wysoki, niski i bardzo niski.
Kopiuj
Osadź
kanban
todo[Todo]
id3[Update Database Function]@{ ticket: MC-2037, assigned: 'knsv', priority: 'High' }
Opcje konfiguracji
Diagram kanban można dostosować za pomocą bloku konfiguracji na początku pliku markdown. Jest to przydatne do ustawiania ustawień globalnych (takich jak bazowy URL zgłoszeń). Obecnie diagram kanban <code>ticketBaseUrl</code> jest to bardzo przydatne do ustawiania ustawień globalnych, na przykład bazowego URL zgłoszeń. Obecnie diagram kanban ma jedną opcję konfiguracji: ticketBaseUrl. Można ją ustawić zgodnie z poniższym przykładem:
Kopiuj
Osadź
---
config:
kanban:
ticketBaseUrl: 'https://yourproject.atlassian.net/browse/#TICKET#'
---
Gdy wpis kanban ma określony numer zgłoszenia, numer zgłoszenia na diagramie będzie zawierał łącze do systemu zewnętrznego definiującego to zgłoszenie. Ustawienie ticketBaseUrl wskazuje bazowy URL systemu zewnętrznego, a #TICKET# zostanie zastąpione wartością zgłoszenia z metadanych zadania, aby utworzyć prawidłowe łącze.
Pełny przykład
Oto przykład pełnego kodu diagramu kanban:
Kopiuj
Osadź
---
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]
Podsumowując, tworzenie diagramu kanban w Mermaid to prosty proces, który pozwala skutecznie zwizualizować Twój proces roboczy.
Możesz wzbogacić diagram, dodając opcjonalne metadane do zadań za pomocą składni @{ ... }; ta składnia pozwala umieścić dodatkowe informacje kontekstowe, takie jak osoba odpowiedzialna, numer zgłoszenia i priorytet. W celu dalszego dostosowania użyj bloku konfiguracji na górze pliku, aby ustawić opcje globalne, takie jak ticketBaseUrl, umożliwiające linkowanie zgłoszeń bezpośrednio z diagramu.
Przestrzegając tych wytycznych, zapewniając unikalne identyfikatory, prawidłowe wcięcia oraz wykorzystując metadane i opcje konfiguracji, możesz utworzyć kompleksowy i dostosowany diagram kanban, skutecznie odwzorowujący proces roboczy projektu.
