مخطط كانبان
تتيح لك لوحة كانبان في 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، لربط البطاقات مباشرة من المخطط.
باتّباع هذه الإرشادات، مع ضمان المعرّفات الفريدة والإزاحة الصحيحة والاستفادة من خيارات البيانات الوصفية والتكوين، يمكنك إنشاء لوحة كانبان شاملة ومخصّصة تعكس سير عمل مشروعك بصورة فعّالة.
