Kanban StudioMarkdown & JSON Reference
📝

Markdown & JSON Reference

Full schema reference for board editing

Yleiskatsaus

Jokaisen kanban-taulun takana on selkeä merkintä, jonka voit lukea, kirjoittaa, kopioida ja tarkistaa versioasi. Dokumentti koostuu kahdesta osasta: koneen lukemattomasta rakenteellisesta blokista, joka sisältää taulukon tiedot JSON:n muodossa, ja vapaasta räätälöitystä blokista henkilökohtaisten muistiinpanojensi varten.

Järjestelmä v1JSON + MarkdownKuivausvalvontavalvoja
💡

Kokeile aina ensin kuivat

Ennen kuin napsautat Opetus, käytä painiketta Kokeilu vahvistamaan muutokset. Backend ilmoittaa virheistä ja erien yhteenvetoista muuttamatta taulusi.

Asiakirjan rakenne

Kanbanin markdown-asiakirja koostuu kolmesta osasta::

  • Ihmisille luettavissa oleva otsikko (taulukirja, generaatiotunnus)
  • Strukturoitu blokki JSON-tietoja HTML-kommenttimerkkien välissä
  • Käyttäjäluettelo** ilmainen markdown (ilmoitukset, mermaid-diagrammat, linkit)
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 -->
Täydellinen tauluasiakirja, jossa on huomautuksia kaikista osista
⚠️

Älä poista kommenttimerkkejä

Merkittäjät <!-- KANBAN:STRUCTURED:START -->, <!-- KANBAN:STRUCTURED:END -->, <!-- KANBAN:CUSTOM:START --> ja <!-- KANBAN:CUSTOM:END --> ovat tarpeen. Poistaminen johtaa analyysivirheeseen.

Sarakkeet

Luvut määrittelevät taulusi toimintatapoja. He tulevat vasemmalta oikealle order-Arvonmuutos.

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 }
]
Esimerkki: neljä eri värisiä sarakkeita
FieldTypeRequiredDescription
idstringYesYksityinen sarakkeen merkki (UUID tai mikä tahansa vakaa slug)
titlestringYesTaulukossa näkyvä sarakkeen otsikko
colorstringYesVarjojen aksenttiväri (hex). Näytetään kartissa vasemmalla puolella
orderintegerYesNollapohjainen ilmoitusjärjestys (nouseva, vasemmasta oikealle)
ℹ️

Note

Julkaisujen tunnisteiden on oltava selkeät taulussa. Työtehtävät viittaavat sarakkeisiin id.

Tehtävät

Tehtävät ovat työn ydinyksikkö. Jokainen tehtävä on luvussa columnId) ja on tämän luvun sisällä position järjestetty.

Vähimmäismäärä

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": []
}
Vain pakollisia kenttiä täytetty kaikki vaihtoehtoiset kentät ovat nolla/tommat

Täydellinen tehtävä kaikilla aloilla

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 }
  ]
}
Tuotannon esimerkki, jossa on ensisijaisuus, merkinnät, valtuutetut, tarkistuslista, ajanmuoto
FieldTypeRequiredDescription
idstringYesYksityinen tehtävän tunnistaminen (UUID tai Stable Slug)
columnIdstringYesTähän tehtävään kuuluvan sarakkeen ID
positionintegerYesNollapohjainen luokitusjärjestys luvussa
titlestringYesTehtävän otsikko (1280 merkkiä)
descriptionstringNoMarkdown-yhteensopiva pitempi kuvaus
priorityenum
"low""medium""high""critical"
NoTehtävän kiireellisyysaste
tagsstring[]NoVapaan muotoisen merkinnän sarjat, joita voidaan suodattaa ja ryhmittää
assigneeIdsstring[]NoTämän tehtävän suorittaneiden henkilöiden jäsen-ID:t
mentionMemberIdsstring[]NoTässä tehtävässä mainittuja (myös ilmoitettuja) jäsenidenttejä
estimatePointsinteger|nullNoTarina-pisteen arviointi (Fibonacci): 1, 2, 3, 5, 8, 13…)
dueDatestring|nullNoISO 8601 päivämääräjärjestys: JJJJ-MM-TT
plannedStartAtstring|nullNoISO 8601 Päivä/aika: suunniteltu aloitus
plannedEndAtstring|nullNoISO 8601 Päivä/aika: suunniteltu loppu
timeboxMinutesinteger|nullNoTimeboxingin keskustelun pituus
isCompletedbooleanNoMerkitse tehtävä valmiina (lisää läpimurrosta käyttöliittymälään)
archivedAtstring|nullNoISO 8601 Tehtävän arkistoinnin päivämäärä ja aika. Arkivoituja tehtäviä ei ole näkynyt taulussa
checklistobject[]NoOsat alitoimintojen tarkistuslistasta (ks. kohta Tarkistuslista)“)

Tarkastusluettelon elementit

Kunkin tehtävän tukeminen tarkisteluettelon pinnan luettelo Yksinkertaiset alatehtävät, jotka voidaan tunnistaa yksitellen suoritetuksi ilman erillisiä tehtäviä.

JSON
"checklist": [
  { "title": "Design mockup",   "isDone": true  },
  { "title": "Code review",     "isDone": false },
  { "title": "Deploy to prod",  "isDone": false }
]
Kolme tarkistuslistan kohdetta: ensimmäinen on tehty, kaksi jäljellä
FieldTypeRequiredDescription
titlestringYesTarkastusluettelin merkintä (1255 merkkiä)
isDonebooleanYesOnko tämä kohta katettu?

Osa Käytännölliset huomautukset“.

Kaikki väliin <!-- KANBAN:CUSTOM:START --> ja <!-- KANBAN:CUSTOM:END --> on muistiinpano. Se tukee täydellisiä markdown- ja mermaiden kaavioita. Sisältöä ei paista board-moottori. Se näkyy vain näyttökortissa.

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 -->
Mervirgin Gantt-diagrammin muistiinpanoja
💡

Tip

Käytä Käytännöllinen jaksoa sprinttiedotteisiin, joukkuelinkeihin, Gantt-diagreihin, arkkitehtuurin kaavioihin kaiken, mitä haluat nähdä taulun tietojen lisäksi.

Prioriteettiarvot

Alue priority Hyväksyy täsmälleen yksi neljästä arvoista. Kullekin on annettava tietty merkkivärin käyttöliittymä.:

FieldTypeRequiredDescription
lowenum valueNoVähä kiireisyys. Kuvattuna kallioina/grays.
mediumenum valueNoStandardi. Kuvaus: Bernstein/Yellow. Prioriteetin hylkääminen on standardointi.
highenum valueNoTärkeä. Kuvassa oranssissa.
criticalenum valueNoKiertää. Kuvassa punainen/punainen.

Arkivaatiot

Arkistoi tehtävä asettamalla archivedAt-kenttään ISO 8601 -muotoinen päivämäärä ja kellonaika. Arkistoidut tehtävät eivät näy aktiivisella taululla, mutta kaikki niiden tiedot säilyvät.

JSON
{
  "id": "task-old",
  "columnId": "col-1",
  "position": 99,
  "title": "Old completed task",
  "archivedAt": "2025-01-10T14:30:00.000Z",
  ...
}
Arkivoitu tehtävä ei ole näkynyt laudasta.
ℹ️

Note

Jos asetat archivedAt nolla, tehtävän arkistointi poistetaan. Diff-yhteenveto osoittaa tasksToArchive, kun käytössä on markdown-näytelmä, joka arkistoi tällä hetkellä aktiivisia tehtäviä taululla.

Tutkimus ja diagnosointi

Tutkimustoiminta vahvistaa laskusi ilman muutoksia. Päänpäätä antaa diffSummary (Se ei kuitenkaan ole mahdollista. diagnostics-Järjestelmä takaisin, jossa on luettelo kaikista virheistä tai varoituksista.

Menestynyt näytteenotto

JSON
{
  "ok": true,
  "dryRun": true,
  "diagnostics": [],
  "diffSummary": {
    "columnsCreated": 1,
    "columnsTouched": 2,
    "tasksCreated": 3,
    "tasksTouched": 5,
    "tasksToArchive": 0
  }
}
ok: true tarkoittaa, että vähennys on voimassa ja sovellettavissa turvallisesti

Kokeilu ja virheet

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 korjata virheitä ennen käyttöä
FieldTypeRequiredDescription
codestringYesKoneen lukemattoman virheenkoodin (z). B. tuntematon_Spalten_ID)
messagestringYesIhmisille luettavissa oleva ongelman kuvaus
lineintegerYesMarkdown-asiakirjan luvun lukumäärä
severityenum
"error""warning"
Yesjoko virheet (säännöt ovat voimassa) tai varoitus (käytetään tuloksia)
🚫

Virheitä estäminen Apply

Jos diagnoosissa on elementti, jonka painopiste on virhe, Apply-prosessi kieltäytyy jatkamasta. Varoitukset ovat neuvoa-antavia eivätkä estä.

Suositeltu työsuunnitelma

Seuraa tätä menettelyä, kun tarkistat taulukkoa Markdownin kautta.:

  • Avaa markdown-paneeli taulullasi
  • Muokkaa JSON Structured Block Lisää sarakkeita tai tehtäviä/muokkaa ne
  • Klikkaa Dry Run voidaksesi validoida ilman muutoksia
  • Korjaa kaikki diagnosointiluettelossa olevat virheet
  • Klikkaa Opettaa, jotta voit tehdä live-taulun muutoksia
  • Käytä lataa paikallista .md-Varmuuskopiointi
💡

Versio-ohjausvihje

Koska asiakirja on puhdasta tekstiä, voit laittaa sen Git-varastoon, erottaa versioita ja palauttaa aiemman taulukon tilan käyttämällä vanhaa kuvaa uudelleen.

Schema v1 · Updated September 2026