Płyta Kanban to wizualny narzędzie do zarządzania przepływem pracy używane do śledzenia zadań lub elementów pracy na różnych etapach przetwarzania (takich jak lista zadań do wykonania, w trakcie wykonywania i zakończone). Wprowadzona jako funkcja wbudowana w Mermaid.js, ta oparta na tekście metoda pozwala zespołom programistycznym i menedżerom projektów szybko tworzyć interaktywne pulpity zadań w plikach dokumentacji bez zarządzania ręcznymi aplikacjami do śledzenia lub elementami obrazów zewnętrznych.
Podstawowa struktura składni
Każda płyta Kanban zaczyna się od kanban nagłówka deklaracji. Kolumny są definiowane za pomocą section słowa kluczowego, a pojedyncze karty zadań są wymienione kolejno pod każdą kolumną, wykorzystując bloki wcięć.
kanban
tytuł "Próbny sprint projektu"
sekcja Do zrobienia
Projektuj schemat bazy danych
Przygotuj trasy interfejsu API
sekcja W trakcie
Zaimplementuj pośrednik uwierzytelniania
Odwołanie do składni
Poniższa tabela rozkłada podstawowe składniki danych i parametry używane do tworzenia mapy płyty Kanban w Mermaid.js.
| Składnik składni | Wymóg typu | Opis i zasady użytkowania |
|---|---|---|
| Deklaracja | Identyfikator słowa kluczowego | Inicjuje parametry mapowania bloku przepływu pracy agilnej. Należy użyć dokładnie kanban bloku. |
| Tytuł | Ciąg w cudzysłowach | Opcjonalny globalny nagłówek obszaru roboczego, wyśrodkowany w górnej części płótna Kanban. |
| Kolumna sekcji | Słowo kluczowe + Nazwa | Definiuje niezależną kolumnę etapu przepływu pracy. Użyj słowa kluczowego section a następnie etykiety kolumny. |
| Karta zadania standardowego | Wcięty ciąg znaków | Opis w formie zwykłego tekstu reprezentujący jedną kartę. Musi być wcięty lub wcięty bezpośrednio pod aktywną sekcją. |
| Karta identyfikatora zadania | Identyfikator w nawiasach | Zaawansowany format śledzenia karty zadania z użyciem jawnego unikalnego tokenu identyfikatora wraz z etykietą wyświetlania: id[Tekst karty]. |
| Blok metadanych | Mapa konfiguracji JSON | Opcjonalny blok właściwości dołączony za pomocą reguły składni @{...} reguły składni do przypisania atrybutów takich jak priorytet biletu lub właścicieli. |
Zaawansowane atrybuty zadania i metadane
Dla szczegółowych sprintów inżynieryjnych lub przepływów śledzenia błędów możesz przypisać atrybuty metadanych bezpośrednio do karty. Poprzez połączenie unikalnego identyfikatora węzła (np. task1[...]) z blokiem deklaracji konfiguracji JSON (@{}), możesz wydrukować strukturalne zmienne takie jak przypisani do zadania, priorytety i wewnętrzne bilety śledzenia bezpośrednio na powierzchni elementu karty.
Obsługiwane zmienne zadania
| Klucz atrybutu | Formatowanie wartości | Widoczny wynik |
|---|---|---|
przypisany |
Ciąg znaków w cudzysłowach | Wyświetla przypisanego właściciela lub etykietę dewelopera bezpośrednio w macierzy szczegółów karty. |
priorytet |
Ciąg skalowy w cudzysłowach | Wyświetla punkty odniesienia dla poważności zadania (np. 'Wysoki', 'Średnia', 'Niska'). |
bilet |
Token liczbowy lub alfanumeryczny | Śledzi powiązane numery zadań rozwojowych lub kody projektów systemowych. |
Prawdziwy szablon: Sprint wydania rozwoju Agile
Ten kompleksowy szablon śledzi wydanie wdrożenia infrastruktury. Wskazuje trzy różne kolumny (Zaplanowane, W trakcie, Gotowe do wdrożenia) i wykorzystuje zaawansowane identyfikatory zadań skojarzone z parametrami metadanych strukturalnych, aby przypisać konkretnych deweloperów i kody biletów w różnych funkcjach.
kanban
tytuł "Tablica wydania podstawowych funkcji Q3"
sekcja Zaplanowane
task101[Stwórz dokumentację punktu końcowego API]@{ przypisano: 'Sarah K', priorytet: 'Średnia' }
task102[Projektuj szkice strony docelowej]
sekcja W trakcie
task201[Doskonal synchronizację zapytań do bazy danych]@{ przypisano: 'Alex M', priorytet: 'Wysoki', bilet: 4012 }
task202[Skonfiguruj składniki interfejsu użytkownika Lightbox]@{ przypisano: 'Sarah K', priorytet: 'Niska' }
sekcja Gotowe do wdrożenia
task301[Zaimplementuj uwierzytelnianie wieloskładnikowe użytkownika]@{ przypisano: 'Zespół deweloperów', bilet: 3985 }
Porada składniowa: Chociaż proste zadania można wpisać jako niecytowane linie zwykłego tekstu, złożone przypisania zawierające parametry metadanych *muszą* używać unikalnego prefiksu ciągu mapowania identyfikatora (takiego jak id1[...]@{...}). Powtarzanie dokładnie tego samego identyfikatora zadania w różnych częściach tablicy spowoduje nadpisanie właściwości lub błędy układu.
Typowe błędy składniowe i ograniczenia systemowe
Podczas projektowania bardzo gęstych systemów układu wieloetapowego pamiętaj o tych parametrach diagnostycznych strukturalnych:
- Zasada sekcji przed kartami: Wszystkie karty zadań muszą znajdować się pod aktywnym blokiem kolumny. Pisząc linię ciągu zadania bezpośrednio pod głównym
kanbantytułem bez deklarowaniasekcjaminagłówka kolumny, kompilacja zostanie zatrzymana. - Białe znaki i wcięcia: Silnik układu śledzenia grupuje karty na podstawie wcięć w linii. Upewnij się, że wszystkie wiersze kart zadań są jednolite w wcięciach pod aktywnymi
sekcjamiznacznikami, aby zapobiec naruszeniom wyrównania. - Format separatora metadanych: Podczas tworzenia niestandardowych atrybutów wewnątrz bloku
@{ }klucze i wartości muszą odpowiadać poprawnym argumentom systemowym. Oddziel wiele atrybutów przecinkami i użyj czystych cudzysłowów otaczających przypisania ciągów znaków. - Zarządzanie gęstością kart: Choć komponent Kanban jest całkowicie odpowiedni, zbyt duża gęstość jednej tablicy z więcej niż 5 kolumnami lub dodanie dziesiątek wierszy z gęstymi metadanych może zmniejszyć czytelność na urządzeniach mobilnych. Zadbaj świadomie o odpowiednie ustawienie odstępów w układzie.