Markdown & JSON referens
Fullständig skema-referens till redigering
Översikt
Bakom varje Kanban-tavla finns ett klartekstmärkande dokument som du kan läsa, skriva, kopiera och kontrollera. Dokumentet består av två delar: en maskinläsbar, strukturerad block som innehåller bräddataten i form av JSON och ett fritt, anpassad block för dina personliga anteckningar.
Först och främst ta en torrläcka
Innan du klickar på Overnehmen, använd knappen Probeview för att validera dina ändringar. Backend rapporterar fel och en diff sammanfattning utan att ändra din skiva.
Dokumentstruktur
En fullständig Kanban-markdown-dokument består av tre delar:
- En rubrik som kan läsas av människor (bordtitlar, generationsnoter)
- Den strukturerade blocken JSON-data mellan HTML-kommentarmärkningarna
- Det är en kostnadsfri markdown (Notices, Mermaid diagram, Links)
# 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 -->Ta inte bort kommentarfält
Märkningarna <!-- KANBAN:STRUCTURED:START -->, <!-- KANBAN:STRUCTURED:END -->, <!-- KANBAN:CUSTOM:START --> och <!-- KANBAN:CUSTOM:END --> behövs. Att ta bort det leder till ett analysfel.
Kolumner
Kolor definierar arbetssättet på din skiva. De går från vänster till höger genom deras order-värde.
"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 }
]| Fält | Typ | Behövs | Standard | Beskrivning |
|---|---|---|---|---|
id | string | Ja | — | Enklare kolumnsbetecknare (UUID eller någon stabil slug) |
title | string | Ja | — | Kolumnsrubriken visas i tabellen |
color | string | Ja | #64748b | Kolumnsaktsfärg (hex). Visas som en vänster rand på kort |
order | integer | Ja | — | Nollbaserad anmälan (uppåt, från vänster till höger) |
Note
Kolumn-ID:er måste vara tydliga inom tavlan. Uppgifterna hänvisas till kolumner med hjälp av denna id.
Uppgifter
Uppgifter är arbetets kärna enhet. Varje uppgift är i en kolumn (över kolumnId) och sorteras enligt position inom denna kolumn.
Minimal uppgift
{
"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": []
}Fullständig uppgift med alla områden
{
"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 }
]
}| Fält | Typ | Behövs | Standard | Beskrivning |
|---|---|---|---|---|
id | string | Ja | — | Enklara uppgiftsbeteckningar (UUID eller Stable Slug) |
columnId | string | Ja | — | ID för den kolumn där denna uppgift ingår |
position | integer | Ja | — | Nollbaserad sorteringsordning inom kolumnen |
title | string | Ja | — | Uppgiftstitel (1280 tecken) |
description | string | Nej | "" | Markdown-kompatibel längre beskrivning |
priority | enum "low""medium""high""critical" | Nej | medium | Hur mycket är det brådskande? |
tags | string[] | Nej | [] | Frittformade teckningsserier för filtrering och gruppering |
assigneeIds | string[] | Nej | [] | Medlems-ID:er för personer som har tilldelats denna uppgift |
mentionMemberIds | string[] | Nej | [] | I denna uppgift nämndes (meddelade) medlems-ID:er |
estimatePoints | integer|null | Nej | null | Story-point uppskattning (Fibonacci): 1, 2, 3, 5, 8, 13…) |
dueDate | string|null | Nej | null | ISO 8601 Datumskäl: JJJJ-MM-TT |
plannedStartAt | string|null | Nej | null | ISO 8601 Datum/tid: planerad start |
plannedEndAt | string|null | Nej | null | ISO 8601 Datum/tid: planerat slut |
timeboxMinutes | integer|null | Nej | null | Längden på timeboksningssessionen |
isCompleted | boolean | Nej | false | Märker uppgiften som utförd (tillägger passning i användargränsen) |
archivedAt | string|null | Nej | null | ISO 8601 Datum och tid för arkivering av uppgiften. Arkiverade uppgifter är inte upptagna i tavlan |
checklist | object[] | Nej | [] | Element i underuppgifterna checklistan (se avsnitt Checklist)“) |
Kontrolllistans element
Varje uppgift stöder en platt lista över kontrolllistaelement Enkla underuppgifter som kan markeras som utförda individuellt utan att det behövs separata uppgifter.
"checklist": [
{ "title": "Design mockup", "isDone": true },
{ "title": "Code review", "isDone": false },
{ "title": "Deploy to prod", "isDone": false }
]| Fält | Typ | Behövs | Standard | Beskrivning |
|---|---|---|---|---|
title | string | Ja | — | Märkning av checklistan (1255 tecken) |
isDone | boolean | Ja | — | Om den här punkten är avskuren |
Avsnitt Användardefinierade anteckningar“.
Allt mellan <!-- KANBAN:CUSTOM:START --> och <!-- KANBAN:CUSTOM:END --> är din anteckningsblock. Det stöder fullständiga markdown- och mermaiddiagram. Innehållet kommer inte att klippas av board-motorn det visas bara på tabellen Preview.
<!-- 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
Använd avsnittet Användardefinierat för sprintnoter, teamlänkar, Gantt diagram, arkitektoniska diagram allt du vill se utöver din borddata.
Prioriterade värden
Fältet priority accepterar exakt en av fyra värden. Var och en av dem ska tillskrivas en särskild varumärke i användargränsen:
| Fält | Typ | Behövs | Standard | Beskrivning |
|---|---|---|---|---|
low | enum value | Nej | — | Mindre akuthet. Uppvisat i skitt/grå. |
medium | enum value | Nej | — | Standard. Uppvisat i bröststen/gel. Att avlägsna prioriteringen är standardiseringen. |
high | enum value | Nej | — | Viktigt. I orange. |
critical | enum value | Nej | — | Blokera. Uppvisat i rött/rosa. |
Arkiveringsarbete
Om du vill arkivera en uppgift, ange fältet archivedAt på en ISO-datum/tidsskedja. Arkiverade uppgifter uteslutas från den aktiva tavlan men kvarstår i gång.
{
"id": "task-old",
"columnId": "col-1",
"position": 99,
"title": "Old completed task",
"archivedAt": "2025-01-10T14:30:00.000Z",
...
}Note
Om du sätter archivedAt på noll kommer arkivering av uppgiften att upphöra. Diff sammanfattningen visar tasksToArchive när en markdown-snapshot används för att arkivera aktuella uppgifter på tavlan.
Provning och diagnos
Den provfunktion som validerar din avskrivning utan ändringar. Bakendet ger en diffSummary (som skulle ändras) och en diagnostics-array som listar alla fel eller varningar.
Framgångsrikt provreaktion
{
"ok": true,
"dryRun": true,
"diagnostics": [],
"diffSummary": {
"columnsCreated": 1,
"columnsTouched": 2,
"tasksCreated": 3,
"tasksTouched": 5,
"tasksToArchive": 0
}
}Försökningsprocess med fel
{
"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
}
}| Fält | Typ | Behövs | Standard | Beskrivning |
|---|---|---|---|---|
code | string | Ja | — | Maskinläsbar felkod (z). B. okända_spalten_ID) |
message | string | Ja | — | Beskrivning av problemet som kan läsas av människor |
line | integer | Ja | — | Omfattande radnummer i markdowndokumentet |
severity | enum "error""warning" | Ja | — | Antingen fel (lockningar gäller) eller varning (använd inkomster) |
Falska blockering Apply
Om diagnosen innehåller ett element med svårighetsgraden fel, vägrar appliceringsprocessen att fortsätta. Varningar har en rådgivande karaktär och blockerar inte.
Rekommenderad arbetsflöde
Följ denna process när du redigerar tavlan via Markdown:
- Öppna markdown-panelen på din skiva
- Redigera JSON i Structured Block Lägg till kolumner eller uppgifter/ändra dem
- Klicka på Tryck Run för att valitera utan att ändra något
- Lägg till alla fel som visas i diagnoslistan
- Klicka på Ändra för att göra ändringar i live-tavlan
- Använd download för att spara ett lokalt
.md-backup
Tips för versionkontroll
Eftersom dokumentet är rent text, kan du lägga in det i ett Git-register, skilja mellan versioner och återställa tidigare bordstatus genom att återanvända en äldre bild.