Kanban StudioMarkdown & JSON Reference
📝

Markdown & JSON Reference

Full schema reference for board editing

Ընդհանուր ակնարկ

Յուրաքանչյուր Kanban տախտակ ապահովված է պարզ տեքստային Markdown փաստաթղթով, որը կարող եք կարդալ, գրել, պատճենել և վերահսկել տարբերակը: Փաստաթուղթն ունի երկու բաժին՝ մեքենայաընթեռնելի Կառուցվածքային բլոկ, որը պահում է տախտակի տվյալները որպես JSON, և ազատ ձևի Պատվիրված բլոկ ձեր անձնական նշումների համար:

Սխեման v1JSON + MarkdownՉոր վազքով անվտանգ
💡

Միշտ առաջին հերթին չորացրեք

Նախքան «Դիմել» սեղմելը, օգտագործեք «Չորացնել» կոճակը՝ ձեր խմբագրումները հաստատելու համար: Հետին պլանը կհաղորդի սխալների և տարբերությունների ամփոփագիր՝ առանց ձեր տախտակը փոփոխելու:

Փաստաթղթի կառուցվածքը

Ամբողջական Kanban Markdown փաստաթուղթը բաղկացած է երեք մասից.

  • Մարդու կողմից ընթեռնելի վերնագիր (տախտակի վերնագիր, սերնդի նշում)
  • Կառուցվածքային բլոկ — JSON տվյալներ HTML մեկնաբանությունների մարկերների միջև
  • Պատվերով բլոկ — անվճար Markdown (նշումներ, ջրահարսի դիագրամներ, հղումներ)
board.md
# My Project Board

Generated by Kanban Markdown schema v1.

<!-- KANBAN:STRUCTURED:START -->
```kanban-structured
{
  "version": 1,
  "board": {
    "id": "board-abc123",
    "title": "My Project Board"
  },
  "columns": [
    { "id": "col-1", "title": "Backlog",     "color": "#64748b", "order": 0 },
    { "id": "col-2", "title": "In Progress", "color": "#6366f1", "order": 1 },
    { "id": "col-3", "title": "Done",        "color": "#10b981", "order": 2 }
  ],
  "tasks": [
    {
      "id": "task-1",
      "columnId": "col-2",
      "position": 0,
      "title": "Build authentication flow",
      "description": "Implement JWT login, register, and token refresh.",
      "priority": "high",
      "tags": ["backend", "security"],
      "assigneeIds": ["member-uuid-1"],
      "mentionMemberIds": ["member-uuid-2"],
      "estimatePoints": 5,
      "dueDate": "2025-03-15",
      "plannedStartAt": "2025-03-10",
      "plannedEndAt": "2025-03-15",
      "timeboxMinutes": 90,
      "isCompleted": false,
      "archivedAt": null,
      "checklist": [
        { "title": "Design DB schema",   "isDone": true  },
        { "title": "Write unit tests",   "isDone": false },
        { "title": "Deploy to staging",  "isDone": false }
      ]
    }
  ]
}
```
<!-- KANBAN:STRUCTURED:END -->

<!-- KANBAN:CUSTOM:START -->
## Team Notes

- Sprint ends Friday
- Backend review at 3 PM

```mermaid
flowchart LR
  A[Backlog] --> B[In Progress] --> C[Done]
```
<!-- KANBAN:CUSTOM:END -->
Լրացրեք տախտակի փաստաթուղթը բոլոր բաժիններով ծանոթագրված
⚠️

Մի հանեք մեկնաբանությունների նշիչները

Մարկերները <!-- KANBAN:STRUCTURED:START -->, <!-- KANBAN:STRUCTURED:END -->, <!-- KANBAN:CUSTOM:START --> և <!-- KANBAN:CUSTOM:END --> պարտադիր են: Դրանք հեռացնելը առաջացնում է վերլուծության սխալ:

Սյունակներ

Սյունակները սահմանում են ձեր տախտակի աշխատանքային հոսքի փուլերը: Դրանք ցուցադրվում են ձախից աջ իրենց order արժեքով:

JSON
"columns": [
  { "id": "col-1", "title": "To Do",       "color": "#64748b", "order": 0 },
  { "id": "col-2", "title": "In Progress", "color": "#6366f1", "order": 1 },
  { "id": "col-3", "title": "Review",      "color": "#f59e0b", "order": 2 },
  { "id": "col-4", "title": "Done",        "color": "#10b981", "order": 3 }
]
Օրինակ՝ չորս սյունակ՝ տարբեր գույներով
FieldTypeRequiredDescription
idstringYesՍյունակի եզակի նույնացուցիչ (UUID կամ ցանկացած կայուն սլագ)
titlestringYesՍյունակի վերնագիրը ցուցադրված է գրատախտակին
colorstringYesՍյունակի շեշտադրման գույնը (վեցանկյուն): Քարտերի վրա ցուցադրվում է որպես ձախ եզրագիծ
orderintegerYesՑուցադրման զրոյական կարգը (աճող, ձախից աջ)
ℹ️

Note

Սյունակների ID-ները պետք է եզակի լինեն տախտակի ներսում: Առաջադրանքների հղման սյունակներն ըստ այս id:

Առաջադրանքներ

Առաջադրանքները աշխատանքի հիմնական միավորն են: Յուրաքանչյուր առաջադրանք ապրում է սյունակի ներսում (columnId միջոցով) և դասավորված է ըստ position սյունակի ներսում:

Նվազագույն առաջադրանք

JSON
{
  "id": "task-abc",
  "columnId": "col-1",
  "position": 0,
  "title": "Write release notes",
  "description": "",
  "priority": "medium",
  "tags": [],
  "assigneeIds": [],
  "mentionMemberIds": [],
  "estimatePoints": null,
  "dueDate": null,
  "plannedStartAt": null,
  "plannedEndAt": null,
  "timeboxMinutes": null,
  "isCompleted": false,
  "archivedAt": null,
  "checklist": []
}
Լրացված են միայն պարտադիր դաշտերը. բոլոր կամընտիր դաշտերը զրոյական են/դատարկ

Ամբողջական առաջադրանք բոլոր դաշտերով

JSON
{
  "id": "task-xyz",
  "columnId": "col-2",
  "position": 0,
  "title": "Redesign checkout page",
  "description": "Full UX overhaul based on user research findings.",
  "priority": "critical",
  "tags": ["ux", "frontend", "q1-goal"],
  "assigneeIds": ["member-alice", "member-bob"],
  "mentionMemberIds": ["member-pm"],
  "estimatePoints": 8,
  "dueDate": "2025-04-01",
  "plannedStartAt": "2025-03-20",
  "plannedEndAt": "2025-04-01",
  "timeboxMinutes": 120,
  "isCompleted": false,
  "archivedAt": null,
  "checklist": [
    { "title": "User interviews",       "isDone": true  },
    { "title": "Wireframes approved",   "isDone": true  },
    { "title": "Implement components",  "isDone": false },
    { "title": "A/B test live",         "isDone": false }
  ]
}
Արտադրության օրինակ՝ առաջնահերթությամբ, պիտակներ, հանձնարարվածներ, ստուգաթերթ, ժամանակի հետևում
FieldTypeRequiredDescription
idstringYesԵզակի առաջադրանքի նույնացուցիչ (UUID կամ կայուն slug)
columnIdstringYesՍյունակի ID, որին պատկանում է այս առաջադրանքը
positionintegerYesԶրոյի վրա հիմնված տեսակավորման կարգը սյունակի ներսում
titlestringYesԱռաջադրանքի անվանումը (1–280 նիշ)
descriptionstringNoMarkdown-ի հետ համատեղելի ավելի երկար նկարագրություն
priorityenum
"low""medium""high""critical"
NoԱռաջադրանքի հրատապության մակարդակը
tagsstring[]NoԱզատ ձևի պիտակների տողեր զտման և խմբավորման համար
assigneeIdsstring[]NoԱյս առաջադրանքին հանձնարարված մարդկանց անդամի ID-ներ
mentionMemberIdsstring[]NoԱյս առաջադրանքում նշված (ծանուցված) անդամի ID-ները
estimatePointsinteger|nullNoՊատմության կետի գնահատում (Ֆիբոնաչի՝ 1, 2, 3, 5, 8, 13…)
dueDatestring|nullNoISO 8601 ամսաթվի տող՝ YYYY-MM-DD
plannedStartAtstring|nullNoISO 8601 ամսաթիվը. ծրագրված սկիզբ
plannedEndAtstring|nullNoISO 8601 ամսաթվերը` պլանավորված ավարտ
timeboxMinutesinteger|nullNoՖոկուս-սեսիայի երկարությունը ժամանակային բռնցքամարտի համար
isCompletedbooleanNoՆշում է առաջադրանքը որպես կատարված (ավելացնում է մատնանշում միջերեսում)
archivedAtstring|nullNoISO 8601 ամսաթիվը, երբ առաջադրանքը արխիվացվել է: Արխիվացված առաջադրանքները թաքնված են գրատախտակից
checklistobject[]NoԵնթաառաջադրանքների ստուգաթերթի տարրեր (տես ստուգաթերթի բաժինը)

Ստուգաթերթի կետեր

Յուրաքանչյուր առաջադրանք աջակցում է ստուգաթերթի կետերի հարթ ցուցակին. թեթև ենթաբաժիններ, որոնք կարող են անհատապես նշվել որպես կատարված՝ առանց առանձին առաջադրանքներ ստեղծելու:

JSON
"checklist": [
  { "title": "Design mockup",   "isDone": true  },
  { "title": "Code review",     "isDone": false },
  { "title": "Deploy to prod",  "isDone": false }
]
Ստուգաթերթի երեք կետ. առաջինը կատարված է, մնացածը երկուսը
FieldTypeRequiredDescription
titlestringYesՍտուգացանկի տարրերի պիտակ (1–255 նիշ)
isDonebooleanYesԱնջատված է արդյոք այս տարրը

Պատվերով նշումների բաժին

Ամեն ինչ <!-- KANBAN:CUSTOM:START -->-ի և <!-- KANBAN:CUSTOM:END -->-ի միջև ձեր քերծվածքն է: Այն աջակցում է Markdown-ի և Mermaid-ի ամբողջական դիագրամներին: Բովանդակությունը երբեք չի վերլուծվում տախտակի շարժիչով. այն ցուցադրվում է միայն Նախադիտման ներդիրում:

Markdown
<!-- KANBAN:CUSTOM:START -->
## Sprint Notes

- Daily standup at 10:00 AM
- Backend API freeze on Friday

```mermaid
gantt
  title Sprint 12
  section Tasks
  Auth flow     :done, 2025-03-10, 3d
  Dashboard UI  :active, 2025-03-13, 4d
  API docs      :2025-03-17, 2d
```

> Reminder: update JIRA tickets before end of day.
<!-- KANBAN:CUSTOM:END -->
Նշումներ Mermaid Gantt աղյուսակով
💡

Tip

Օգտագործեք Պատվերով բաժինը սպրինտային նշումների, թիմային հղումների, Gantt գծապատկերների, ճարտարապետական գծապատկերների համար. այն ամենը, ինչ ցանկանում եք, տեսանելի լինի ձեր տախտակի տվյալների հետ միասին:

Առաջնահերթ արժեքներ

priority դաշտն ընդունում է չորս արժեքներից ճիշտ մեկը: Յուրաքանչյուրը քարտեզագրվում է UI-ում տարբեր նշանակի գույնի.

FieldTypeRequiredDescription
lowenum valueNoՑածր շտապողականություն. Ցուցադրված է թերթաքարով/մոխրագույնով:
mediumenum valueNoԿանխադրված: Ցուցադրված է սաթ/դեղին գույնով: Սրա առաջնահերթությունների լռելյայն բացթողում:
highenum valueNoԿարևոր. Ցուցադրված է նարնջագույնով:
criticalenum valueNoԱրգելափակում. Ցուցադրված է կարմիր/վարդագույն:

Արխիվացման առաջադրանքներ

Առաջադրանքն արխիվացնելու համար դրա archivedAt դաշտը դրեք ISO ամսաթվի տողի վրա: Արխիվացված առաջադրանքները բացառված են ակտիվ տախտակի դիտումից, բայց պահպանվում են պատմության մեջ:

JSON
{
  "id": "task-old",
  "columnId": "col-1",
  "position": 99,
  "title": "Old completed task",
  "archivedAt": "2025-01-10T14:30:00.000Z",
  ...
}
Արխիվացված առաջադրանք — թաքնված է տախտակից, պահպանված է ակնթարթում
ℹ️

Note

archivedAt-ի զրոյականի սահմանումը վերացնում է առաջադրանքի արխիվացումը: Տարբերության ամփոփագիրը ցույց կտա tasksToArchive-ը, երբ կիրառում եք գծանշման պատկեր, որը արխիվացնում է ընթացիկ տախտակում գործող առաջադրանքները:

Չոր վազում և ախտորոշում

Dry-run ֆունկցիան վավերացնում է ձեր նշագրումը առանց փոփոխություններ կիրառելու: Backend-ը վերադարձնում է diffSummary (ինչը կփոխվի) և diagnostics զանգված՝ թվարկելով ցանկացած սխալ կամ նախազգուշացում:

Չոր վազքի հաջող պատասխան

JSON
{
  "ok": true,
  "dryRun": true,
  "diagnostics": [],
  "diffSummary": {
    "columnsCreated": 1,
    "columnsTouched": 2,
    "tasksCreated": 3,
    "tasksTouched": 5,
    "tasksToArchive": 0
  }
}
լավ. ճշմարիտ նշանակում է, որ նշումը վավեր է և անվտանգ է կիրառելու համար

Չոր վազում սխալներով

JSON
{
  "ok": false,
  "dryRun": true,
  "diagnostics": [
    {
      "code": "unknown_column_id",
      "message": "Task 'task-xyz' references unknown column 'col-999'.",
      "line": 42,
      "severity": "error"
    },
    {
      "code": "duplicate_task_id",
      "message": "Task ID 'task-abc' is used more than once.",
      "line": 67,
      "severity": "error"
    }
  ],
  "diffSummary": {
    "columnsCreated": 0,
    "columnsTouched": 0,
    "tasksCreated": 0,
    "tasksTouched": 0,
    "tasksToArchive": 0
  }
}
ok: false — ուղղել սխալները նախքան դիմելը
FieldTypeRequiredDescription
codestringYesՄեքենայով ընթեռնելի սխալի կոդ (օրինակ՝ unknown_column_id)
messagestringYesՀարցի մարդու համար ընթեռնելի նկարագրություն
lineintegerYesՆշման փաստաթղթի մոտավոր տողի համարը
severityenum
"error""warning"
YesԿամ «սխալ» (գործում են արգելափակումներ) կամ «նախազգուշացում» (կիրառել հասույթը)
🚫

Սխալների արգելափակում Կիրառել

Եթե ախտորոշումը պարունակում է որևէ ծանրություն՝ «սխալ», ապա Դիմել գործողությունը կհրաժարվի շարունակել: Զգուշացումները խորհրդատվական են և չեն արգելափակում:

Առաջարկվող աշխատանքային հոսք

Markdown-ի միջոցով տախտակը խմբագրելիս հետևեք այս հոսքին.

  • Բացեք Markdown վահանակը ձեր տախտակի վրա
  • Խմբագրել JSON-ը Կառուցվածքային բլոկում — ավելացնել/փոփոխել սյունակներ կամ առաջադրանքներ
  • Սեղմեք Dry-run՝ առանց որևէ բան փոխելու վավերացնելու համար
  • Ուղղեք ախտորոշման ցանկում ցուցադրված բոլոր սխալները
  • Կտտացրեք Դիմել՝ կենդանի տախտակում փոփոխություններ կատարելու համար
  • Օգտագործեք Ներբեռնում տեղական .md կրկնօրինակը պահելու համար
💡

Տարբերակի կառավարման հուշում

Քանի որ փաստաթուղթը պարզ տեքստ է, դուք կարող եք այն տեղադրել Git պահոցում, տարբերակել տարբերակները և վերականգնել տախտակի նախորդ վիճակները՝ կրկին կիրառելով ավելի հին նկար:

Schema v1 · Updated September 2026