Markdown & JSON Reference
Full schema reference for board editing
Ընդհանուր ակնարկ
Յուրաքանչյուր Kanban տախտակ ապահովված է պարզ տեքստային Markdown փաստաթղթով, որը կարող եք կարդալ, գրել, պատճենել և վերահսկել տարբերակը: Փաստաթուղթն ունի երկու բաժին՝ մեքենայաընթեռնելի Կառուցվածքային բլոկ, որը պահում է տախտակի տվյալները որպես JSON, և ազատ ձևի Պատվիրված բլոկ ձեր անձնական նշումների համար:
Միշտ առաջին հերթին չորացրեք
Նախքան «Դիմել» սեղմելը, օգտագործեք «Չորացնել» կոճակը՝ ձեր խմբագրումները հաստատելու համար: Հետին պլանը կհաղորդի սխալների և տարբերությունների ամփոփագիր՝ առանց ձեր տախտակը փոփոխելու:
Փաստաթղթի կառուցվածքը
Ամբողջական Kanban Markdown փաստաթուղթը բաղկացած է երեք մասից.
- Մարդու կողմից ընթեռնելի վերնագիր (տախտակի վերնագիր, սերնդի նշում)
- Կառուցվածքային բլոկ — JSON տվյալներ HTML մեկնաբանությունների մարկերների միջև
- Պատվերով բլոկ — անվճար Markdown (նշումներ, ջրահարսի դիագրամներ, հղումներ)
# 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 արժեքով:
"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 }
]| Field | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Սյունակի եզակի նույնացուցիչ (UUID կամ ցանկացած կայուն սլագ) |
title | string | Yes | — | Սյունակի վերնագիրը ցուցադրված է գրատախտակին |
color | string | Yes | #64748b | Սյունակի շեշտադրման գույնը (վեցանկյուն): Քարտերի վրա ցուցադրվում է որպես ձախ եզրագիծ |
order | integer | Yes | — | Ցուցադրման զրոյական կարգը (աճող, ձախից աջ) |
Note
Սյունակների ID-ները պետք է եզակի լինեն տախտակի ներսում: Առաջադրանքների հղման սյունակներն ըստ այս id:
Առաջադրանքներ
Առաջադրանքները աշխատանքի հիմնական միավորն են: Յուրաքանչյուր առաջադրանք ապրում է սյունակի ներսում (columnId միջոցով) և դասավորված է ըստ position սյունակի ներսում:
Նվազագույն առաջադրանք
{
"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": []
}Ամբողջական առաջադրանք բոլոր դաշտերով
{
"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 }
]
}| Field | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Եզակի առաջադրանքի նույնացուցիչ (UUID կամ կայուն slug) |
columnId | string | Yes | — | Սյունակի ID, որին պատկանում է այս առաջադրանքը |
position | integer | Yes | — | Զրոյի վրա հիմնված տեսակավորման կարգը սյունակի ներսում |
title | string | Yes | — | Առաջադրանքի անվանումը (1–280 նիշ) |
description | string | No | "" | Markdown-ի հետ համատեղելի ավելի երկար նկարագրություն |
priority | enum "low""medium""high""critical" | No | medium | Առաջադրանքի հրատապության մակարդակը |
tags | string[] | No | [] | Ազատ ձևի պիտակների տողեր զտման և խմբավորման համար |
assigneeIds | string[] | No | [] | Այս առաջադրանքին հանձնարարված մարդկանց անդամի ID-ներ |
mentionMemberIds | string[] | No | [] | Այս առաջադրանքում նշված (ծանուցված) անդամի ID-ները |
estimatePoints | integer|null | No | null | Պատմության կետի գնահատում (Ֆիբոնաչի՝ 1, 2, 3, 5, 8, 13…) |
dueDate | string|null | No | null | ISO 8601 ամսաթվի տող՝ YYYY-MM-DD |
plannedStartAt | string|null | No | null | ISO 8601 ամսաթիվը. ծրագրված սկիզբ |
plannedEndAt | string|null | No | null | ISO 8601 ամսաթվերը` պլանավորված ավարտ |
timeboxMinutes | integer|null | No | null | Ֆոկուս-սեսիայի երկարությունը ժամանակային բռնցքամարտի համար |
isCompleted | boolean | No | false | Նշում է առաջադրանքը որպես կատարված (ավելացնում է մատնանշում միջերեսում) |
archivedAt | string|null | No | null | ISO 8601 ամսաթիվը, երբ առաջադրանքը արխիվացվել է: Արխիվացված առաջադրանքները թաքնված են գրատախտակից |
checklist | object[] | No | [] | Ենթաառաջադրանքների ստուգաթերթի տարրեր (տես ստուգաթերթի բաժինը) |
Ստուգաթերթի կետեր
Յուրաքանչյուր առաջադրանք աջակցում է ստուգաթերթի կետերի հարթ ցուցակին. թեթև ենթաբաժիններ, որոնք կարող են անհատապես նշվել որպես կատարված՝ առանց առանձին առաջադրանքներ ստեղծելու:
"checklist": [
{ "title": "Design mockup", "isDone": true },
{ "title": "Code review", "isDone": false },
{ "title": "Deploy to prod", "isDone": false }
]| Field | Type | Required | Default | Description |
|---|---|---|---|---|
title | string | Yes | — | Ստուգացանկի տարրերի պիտակ (1–255 նիշ) |
isDone | boolean | Yes | — | Անջատված է արդյոք այս տարրը |
Պատվերով նշումների բաժին
Ամեն ինչ <!-- KANBAN:CUSTOM:START -->-ի և <!-- KANBAN:CUSTOM:END -->-ի միջև ձեր քերծվածքն է: Այն աջակցում է Markdown-ի և Mermaid-ի ամբողջական դիագրամներին: Բովանդակությունը երբեք չի վերլուծվում տախտակի շարժիչով. այն ցուցադրվում է միայն Նախադիտման ներդիրում:
<!-- 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 -->Tip
Օգտագործեք Պատվերով բաժինը սպրինտային նշումների, թիմային հղումների, Gantt գծապատկերների, ճարտարապետական գծապատկերների համար. այն ամենը, ինչ ցանկանում եք, տեսանելի լինի ձեր տախտակի տվյալների հետ միասին:
Առաջնահերթ արժեքներ
priority դաշտն ընդունում է չորս արժեքներից ճիշտ մեկը: Յուրաքանչյուրը քարտեզագրվում է UI-ում տարբեր նշանակի գույնի.
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
low | enum value | No | — | Ցածր շտապողականություն. Ցուցադրված է թերթաքարով/մոխրագույնով: |
medium | enum value | No | — | Կանխադրված: Ցուցադրված է սաթ/դեղին գույնով: Սրա առաջնահերթությունների լռելյայն բացթողում: |
high | enum value | No | — | Կարևոր. Ցուցադրված է նարնջագույնով: |
critical | enum value | No | — | Արգելափակում. Ցուցադրված է կարմիր/վարդագույն: |
Արխիվացման առաջադրանքներ
Առաջադրանքն արխիվացնելու համար դրա archivedAt դաշտը դրեք ISO ամսաթվի տողի վրա: Արխիվացված առաջադրանքները բացառված են ակտիվ տախտակի դիտումից, բայց պահպանվում են պատմության մեջ:
{
"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 զանգված՝ թվարկելով ցանկացած սխալ կամ նախազգուշացում:
Չոր վազքի հաջող պատասխան
{
"ok": true,
"dryRun": true,
"diagnostics": [],
"diffSummary": {
"columnsCreated": 1,
"columnsTouched": 2,
"tasksCreated": 3,
"tasksTouched": 5,
"tasksToArchive": 0
}
}Չոր վազում սխալներով
{
"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
}
}| Field | Type | Required | Default | Description |
|---|---|---|---|---|
code | string | Yes | — | Մեքենայով ընթեռնելի սխալի կոդ (օրինակ՝ unknown_column_id) |
message | string | Yes | — | Հարցի մարդու համար ընթեռնելի նկարագրություն |
line | integer | Yes | — | Նշման փաստաթղթի մոտավոր տողի համարը |
severity | enum "error""warning" | Yes | — | Կամ «սխալ» (գործում են արգելափակումներ) կամ «նախազգուշացում» (կիրառել հասույթը) |
Սխալների արգելափակում Կիրառել
Եթե ախտորոշումը պարունակում է որևէ ծանրություն՝ «սխալ», ապա Դիմել գործողությունը կհրաժարվի շարունակել: Զգուշացումները խորհրդատվական են և չեն արգելափակում:
Առաջարկվող աշխատանքային հոսք
Markdown-ի միջոցով տախտակը խմբագրելիս հետևեք այս հոսքին.
- Բացեք Markdown վահանակը ձեր տախտակի վրա
- Խմբագրել JSON-ը Կառուցվածքային բլոկում — ավելացնել/փոփոխել սյունակներ կամ առաջադրանքներ
- Սեղմեք Dry-run՝ առանց որևէ բան փոխելու վավերացնելու համար
- Ուղղեք ախտորոշման ցանկում ցուցադրված բոլոր սխալները
- Կտտացրեք Դիմել՝ կենդանի տախտակում փոփոխություններ կատարելու համար
- Օգտագործեք Ներբեռնում տեղական
.mdկրկնօրինակը պահելու համար
Տարբերակի կառավարման հուշում
Քանի որ փաստաթուղթը պարզ տեքստ է, դուք կարող եք այն տեղադրել Git պահոցում, տարբերակել տարբերակները և վերականգնել տախտակի նախորդ վիճակները՝ կրկին կիրառելով ավելի հին նկար: