Kanban
Pinapayagan ka ng Mermaid kanban diagram na gumawa ng visual na representasyon ng pagdaloy ng mga gawain sa iba't ibang yugto ng workflow, ipinaliwanag sa ibaba kung paano wastong gamitin ang kanban diagram syntax.
Basic
Ang kanban diagram ay nagsisimula sa kanban syntax, pagkatapos ay tutukuyin ang mga column at ang mga gawain sa mga column na ito.
Kopyahin
Embed
kanban
column1[Column Title]
task1[Task Description]
Tukuyin ang column
Ang column ay kumakatawan sa iba't ibang yugto sa workflow, halimbawa "Todo", "In Progress", "Done", atbp. Ang bawat column ay tinutukoy gamit ang natatanging identifier at pamagat na napapalibutan ng square brackets.
Syntax:
Kopyahin
Embed
columnId[Column Title]
- columnId: ang natatanging identifier ng column.
- [Column Title]: ang pamagat na ipinapakita sa ulunan ng column.
比如 id1[Todo]
Magdagdag ng gawain sa column
Ang mga gawain ay ipinapakita ayon sa kani-kanilang column, na may indentation. Ang bawat gawain ay may natatanging identifier at paglalarawan na napapalibutan ng square brackets.
Syntax:
Kopyahin
Embed
taskId[Task Description]
taskId: ang natatanging identifier ng gawain.,[Task Description]: ang paglalarawan ng gawain.
Halimbawa:
Kopyahin
Embed
docs[Create Documentation]
Magdagdag ng metadata sa gawain
Maaari mong gamitin ang @{ ... } syntax upang magdagdag ng karagdagang metadata sa bawat gawain. Ang metadata ay maaaring maglaman ng key-value pair tulad ng assigned, ticket, priority, at ito ay ipapakita sa rendering ng node.
Sinusuportahang metadata key
Assigned: tumutukoy kung sino ang responsable sa gawain.,Ticket: ini-link ang gawain sa ticket o issue number.,Priority: nagsasaad ng urgency ng gawain. Mga pinapayagang halaga: Very High, High, Low, at Very Low.
Kopyahin
Embed
kanban
todo[Todo]
id3[Update Database Function]@{ ticket: MC-2037, assigned: 'knsv', priority: 'High' }
Configuration option
Maaari mong i-customize ang kanban diagram gamit ang configuration block sa simula ng markdown file. Kapaki-pakinabang ito para sa pagtatakda ng global setting (tulad ng base URL ng ticket). Sa kasalukuyan, ang kanban diagram <code>ticketBaseUrl</code>, ito ay lubhang kapaki-pakinabang para sa pagtatakda ng global setting, tulad ng base URL ng ticket. Sa kasalukuyan, ang kanban chart ay may isang configuration option na ticketBaseUrl. Maaaring itakda ayon sa sumusunod na halimbawa:
Kopyahin
Embed
---
config:
kanban:
ticketBaseUrl: 'https://yourproject.atlassian.net/browse/#TICKET#'
---
Kapag ang kanban entry ay may tinukoy na ticket number, ang ticket number sa chart ay maglalaman ng link patungo sa external system na tumutukoy sa ticket na iyon. Ang ticketBaseUrl setting ay tumuturo sa base URL ng external system, at ang #TICKET# ay papalitan ng ticket value sa metadata ng gawain, upang gumawa ng valid na link.
Kumpletong halimbawa
Ang sumusunod ay isang kumpletong halimbawa ng kanban diagram code:
Kopyahin
Embed
---
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]
Sa madaling salita, ang paggawa ng kanban diagram sa Mermaid ay isang simpleng proseso, na mabisang nagbibiswal sa iyong workflow.
Maaari mong gamitin ang @{ ... } syntax upang magdagdag ng opsyonal na metadata sa gawain upang mapahusay ang iyong chart, pinapayagan ka ng syntax na ito na magsama ng karagdagang impormasyon sa konteksto, tulad ng assignee, ticket number, at priority. Para sa karagdagang customization, gamitin ang configuration block sa tuktok ng file upang itakda ang global option, tulad ng ticketBaseUrl, upang direktang mag-link ng ticket mula sa chart.
Sa pagsunod sa mga alituntuning ito, tinitiyak ang natatanging identifier, wastong indentation, at paggamit ng metadata at configuration option, makakagawa ka ng komprehensibo at customized na kanban diagram, na mabisang nagmamapa sa workflow ng proyekto.