לוח Kanban
תרשים קנבן של Mermaid מאפשר ליצור ייצוג חזותי של זרימת משימות בשלבים שונים של תהליך עבודה; להלן מוסבר כיצד להשתמש נכון בתחביר תרשים הקנבן.
בסיס
תרשים קנבן מתחיל בתחביר kanban, ולאחר מכן מגדיר עמודות ואת המשימות בעמודות אלו.
העתק
הטמעה
kanban
column1[Column Title]
task1[Task Description]
הגדרת עמודה
עמודות מייצגות שלבים שונים בתהליך העבודה, כגון "משימות לביצוע", "בביצוע", "הושלם" וכדומה. כל עמודה מוגדרת באמצעות מזהה ייחודי וכותרת עטופה בסוגריים מרובעים.
תחביר:
העתק
הטמעה
columnId[Column Title]
- columnId: המזהה הייחודי של העמודה.
- [Column Title]: הכותרת המוצגת בראש העמודה.
比如 id1[Todo]
הוספת משימה לעמודה
המשימות מוצגות לפי העמודות שלהן, עם הזחה. כל משימה כוללת מזהה ייחודי ותיאור עטוף בסוגריים מרובעים.
תחביר:
העתק
הטמעה
taskId[Task Description]
taskId: המזהה הייחודי של המשימה.,[Task Description]: תיאור המשימה.
דוגמה:
העתק
הטמעה
docs[Create Documentation]
הוספת מטא-נתונים למשימה
ניתן להשתמש בתחביר @{ ... } כדי להוסיף מטא-נתונים נוספים לכל משימה. המטא-נתונים יכולים לכלול זוגות מפתח-ערך כגון assigned, ticket, priority וכדומה, והם יוצגו ברינדור של הצומת.
מפתחות מטא-נתונים נתמכים
מוקצה ל: מציין מי אחראי למשימה.,כרטיס עבודה: מקשר את המשימה למספר כרטיס עבודה או בעיה.,עדיפות: מציין את דחיפות המשימה. ערכים מותרים: גבוהה מאוד, גבוהה, נמוכה ונמוכה מאוד.
העתק
הטמעה
kanban
todo[Todo]
id3[Update Database Function]@{ ticket: MC-2037, assigned: 'knsv', priority: 'High' }
אפשרויות תצורה
ניתן להתאים אישית את תרשים הקנבן באמצעות בלוק תצורה בראש קובץ markdown. הדבר שימושי להגדרת הגדרות גלובליות (כגון כתובת ה-URL הבסיסית של כרטיס העבודה). נכון לעכשיו, תרשים הקנבן <code>ticketBaseUrl</code> הדבר שימושי מאוד להגדרת הגדרות גלובליות, כגון כתובת ה-URL הבסיסית של כרטיס העבודה. נכון לעכשיו לתרשים הקנבן יש אפשרות תצורה אחת: ticketBaseUrl. ניתן להגדיר זאת לפי הדוגמה שלהלן:
העתק
הטמעה
---
config:
kanban:
ticketBaseUrl: 'https://yourproject.atlassian.net/browse/#TICKET#'
---
כאשר לרשומת קנבן יש מספר כרטיס עבודה מוגדר, מספר כרטיס העבודה בתרשים יכיל קישור למערכת החיצונית המגדירה את כרטיס העבודה. ticketBaseUrl מגדיר את כתובת ה-URL הבסיסית למערכת החיצונית, ו-#TICKET# מוחלף בערך כרטיס העבודה מהמטא-נתונים של המשימה, כדי ליצור קישור תקין.
דוגמה מלאה
להלן דוגמת קוד מלאה של תרשים קנבן:
העתק
הטמעה
---
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]
לסיכום, יצירת תרשים קנבן ב-Mermaid היא תהליך פשוט, שיכול להציג ביעילות את תהליך העבודה שלך באופן חזותי.
ניתן להשתמש בתחביר @{ ... } כדי להוסיף מטא-נתונים אופציונליים למשימות ולשפר את התרשים; תחביר זה מאפשר לכלול מידע הקשרי נוסף, כגון האחראי, מספר כרטיס העבודה והעדיפות. להתאמה אישית נוספת, השתמש בבלוק התצורה שבראש הקובץ כדי להגדיר אפשרויות גלובליות, כגון ticketBaseUrl, כדי לקשר כרטיסי עבודה ישירות מהתרשים.
על ידי ביצוע הנחיות אלו - הבטחת מזהים ייחודיים, הזחה נכונה וניצול מטא-נתונים ואפשרויות תצורה - תוכל ליצור תרשים קנבן מקיף ומותאם אישית, המשקף ביעילות את תהליך העבודה של הפרויקט.
