Back to Claude Scientific Skills

Kanban Board Documentation Template

scientific-skills/markdown-mermaid-writing/templates/kanban.md

2.38.011.1 KB
Original Source
<!-- Source: https://github.com/SuperiorByteWorks-LLC/agent-project | License: Apache-2.0 | Author: Clayton Young / Superior Byte Works, LLC (Boreal Bytes) -->

Kanban Board Documentation Template

Back to Markdown Style Guide โ€” Read the style guide first for formatting, citation, and emoji rules.

Use this template for: Tracking work items, sprint boards, project task management, release planning, or any scenario where you need a persistent, markdown-based view of work status. This board IS the tracking system โ€” a file in your repo that evolves with your codebase.

Key features: Visual Mermaid kanban diagram, work item tables with status tracking, WIP limits, blocked items, explicit Won't Do decisions, aging indicators, flow efficiency metrics, and historical throughput.

Philosophy: This board is a file. Modify it in your branch, merge it with your PR. The board evolves WITH the codebase โ€” no external board tool required. Anyone with repo access sees the board, AI agents included.

A kanban board's job is to make work visible. This template serves two purposes: (1) a living board that gets updated as work progresses, and (2) a historical snapshot when archived. The Mermaid diagram gives the instant visual overview; the tables give the detail. Together they answer: What's being worked on? What's blocked? What's done? What's next?

When archived, the board becomes the historical record of what was worked on, what was blocked, and what was completed โ€” all in git history, with full attribution and timestamps. This is the Everything is Code philosophy: project management data lives in the repo, versioned and portable.


File Convention

docs/project/kanban/sprint-2026-w07-agentic-template-modernization.md
docs/project/kanban/release-v2.3.0-launch-readiness.md
docs/project/kanban/project-auth-migration-phase-1.md
  • Directory: docs/project/kanban/
  • Naming: Prefix with board scope (sprint-, release-, project-) + identifier + short lowercase hyphenated description
  • Archiving: When a board is complete, keep it in place โ€” it becomes the historical record

The Template

Everything below the line is the template. Copy from here:


[Board Name] โ€” Kanban Board

[Scope: Sprint W07 2026 / Release v2.3.0 / Project: Auth Migration] [Team/Owner] ยท Last updated: [YYYY-MM-DD HH:MM]


๐Ÿ“‹ Board Overview

Period: [Start date] โ†’ [End date] Goal: [One sentence โ€” what does "done" look like for this board?] WIP Limit: [Max items in "In Progress" โ€” e.g., 3 per person, 6 total]

Visual board

Kanban board showing current work distribution across backlog, in-progress, review, done, blocked, and Won't Do columns:

mermaid
kanban
    Backlog
        task1[๐Ÿ”ง Deploy monitoring]
        task2[๐Ÿ“ Write API docs]
    In Progress
        task3[โš™๏ธ Build user dashboard]
        task4[๐Ÿ› Fix payment timeout]
    In Review
        task5[๐Ÿ‘€ Add export feature]
    Done
        task6[๐Ÿš€ Set up CI pipeline]
        task7[๐Ÿ“Š Database migration]
    Blocked
        task8[โ›” Waiting for security approval]
    Won't Do
        task9[โŒ Drop mobile support in this sprint]

โš ๏ธ Always show all 6 columns โ€” Even if a column has no items, include it with a placeholder. This makes the board structure explicit and ensures categories are never forgotten. Use a placeholder like [No items yet] when a column is empty.


๐Ÿšฆ Board Status

ColumnCountWIP LimitStatus
๐Ÿ“‹ Backlog[N]โ€”[Notes]
๐Ÿ”„ In Progress[N][Limit][๐ŸŸข Under limit / ๐ŸŸก At limit / ๐Ÿ”ด Over limit]
๐Ÿ” In Review[N][Limit][Status]
โœ… Done[N]โ€”[This period]
๐Ÿšซ Blocked[N]โ€”[See blocked section below]
๐Ÿšซ Won't Do[N]โ€”[Explicitly declined with rationale]

โš ๏ธ Always include all 6 columns โ€” Each column represents a workflow state. Even if count is 0, keep the row visible. This prevents categories from being overlooked.


๐Ÿ“‹ Backlog

Prioritized top-to-bottom. Top items are next to be pulled. Include at least one placeholder item if empty.

#ItemPriorityEstimateAssigneeNotes
1[Work item title]๐Ÿ”ด High[S/M/L][Person][Context or dependency]
2[Work item title]๐ŸŸก Medium[Size][Person][Notes]
[No items yet]

๐Ÿ”„ In Progress

Items currently being worked on. Include at least one placeholder item if empty.

ItemAssigneeStartedExpectedDays in columnAgingStatus
[Work item][Person][Date][Date][N]๐ŸŸข๐ŸŸข On track
[No items yet]

๐Ÿ’ก Aging indicator: ๐ŸŸข Under expected time ยท ๐ŸŸก At expected time ยท ๐Ÿ”ด Over expected time โ€” items aging red need attention or re-scoping.

โš ๏ธ WIP limit: [N] / [Limit]. [Under limit / At limit โ€” pull more work / Over limit โ€” finish something before starting new work]


๐Ÿ” In Review

Items awaiting or in code review. Include at least one placeholder item if empty.

ItemAuthorReviewerPRDays in reviewAgingStatus
[Work item][Person][Person]#NNN[N]๐ŸŸข[Awaiting review / Changes requested / Approved]
[No items yet]

โœ… Done

Completed this period. Include at least one placeholder item if empty.

ItemAssigneeCompletedCycle timePR
[Work item][Person][Date][N days]#NNN
[No items completed this period]

๐Ÿšซ Blocked

Items that cannot proceed. Always include at least the placeholder โ€” blocked items are high-signal and should never be hidden.

ItemAssigneeBlocked sinceBlocked byEscalated toUnblock action
[Work item][Person][Date][What's blocking โ€” dependency, decision, external team][Person/team][What needs to happen]
[No blocked items]

๐Ÿ”ด [N] items blocked. [Summary of what's needed to unblock them.]


๐Ÿšซ Won't Do

Explicitly out of scope for this board period. Capture rationale so these decisions are transparent and auditable. Include placeholder if empty.

ItemDate decidedDecision ownerRationaleRevisit trigger
[Work item][Date][Person/team][Why this is intentionally excluded right now][What change would reopen this item]
[No items explicitly declined]

๐Ÿ“Š Metrics

This period

MetricValueTargetTrend
Throughput (items completed)[N][Target][โ†‘/โ†’/โ†“]
Avg cycle time (start โ†’ done)[N days][Target][โ†‘/โ†’/โ†“]
Avg lead time (created โ†’ done)[N days][Target][โ†‘/โ†’/โ†“]
Avg review time[N days][Target][โ†‘/โ†’/โ†“]
Flow efficiency[N%][Target][โ†‘/โ†’/โ†“]
Blocked items[N]0[โ†‘/โ†’/โ†“]
WIP limit breaches[N]0[โ†‘/โ†’/โ†“]
Items aging red[N]0[โ†‘/โ†’/โ†“]

๐Ÿ’ก Flow efficiency = active work time รท total cycle time ร— 100. A healthy team targets 40%+. Below 15% means items spend most of their time waiting, not being worked on.

<details> <summary><strong>๐Ÿ“Š Historical Throughput</strong></summary>
PeriodItems completedAvg cycle timeBlocked days
[Previous period 3][N][N days][N]
[Previous period 2][N][N days][N]
[Previous period 1][N][N days][N]
Current[N][N days][N]
</details>

๐Ÿ“ Board Notes

Decisions made this period

  • [Date]: [Decision and context โ€” e.g., "Deprioritized auth refactor to focus on payment bug"]
  • [Date]: [Added/updated Won't Do decision with explicit rationale and revisit trigger]

Carryover from last period

  • [Item carried over] โ€” [Why it wasn't completed and current status]

Upcoming dependencies

  • [Date]: [External dependency, release, or event that affects this board]

๐Ÿ”— References


Next update: [Date] ยท Board owner: [Person/Team]