npm package: @netddigi/taskflow
Description: Markdown-based PRD & Task Manager for Robot Development
Author: TaskFlow Team
Latest version: 0.5.2

# TaskFlow

> **마크다운 기반 로봇 제품 PRD 관리 시스템**

[![npm version](https://img.shields.io/npm/v/taskflow.svg)](https://www.npmjs.com/package/taskflow)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
[![Node.js](https://img.shields.io/badge/Node.js-18%2B-green.svg)](https://nodejs.org/)

**TaskFlow**는 로봇 개발 팀을 위한 PRD(Product Requirements Document) 전용 관리 시스템입니다.  
마크다운 파일을 기반으로 하여 Git과 완벽하게 통합되며, 추적성 자동 검증과 안전 규격 준수를 지원합니다.

---

## 🚀 설치

```bash
npm install -g taskflow
```

## ⚡ 빠른 시작

```bash
# 프로젝트 초기화
taskflow init my-robot-project
cd my-robot-project

# PRD 생성
taskflow prd create "배터리 온도 감지 기능"

# 칸반 보드 열기
taskboard
```

## ✨ 주요 기능

### 🎯 PRD 특화
- **구조화된 PRD 템플릿**: 로봇 제품 개발에 필요한 모든 섹션 포함
- **추적성 자동 검증**: FR(기능 요구사항) ↔ AC(수용 기준) ↔ TC(테스트 케이스) 연결 추적
- **안전 관리**: Safety Class, FMEA, Risk Level 통합
- **다국어 지원**: 한글/영문 제목 동시 관리

### 💻 개발자 친화적
- **Git 기반**: 마크다운 파일로 버전 관리
- **CLI & TUI**: 강력한 명령줄 인터페이스 + 터미널 UI
- **오프라인 작업**: 100% 로컬 환경 지원
- **자동 검증**: 추적성 누락 자동 감지
- **빠른 검색**: Fuzzy search로 PRD 즉시 검색
- **AI 통합**: CLAUDE, AGENTS, GEMINI, Copilot instruction 파일 자동 생성

### 📊 시각화 & 리포트
- **TUI 칸반 보드**: 터미널에서 실행되는 인터랙티브 칸반 보드
- **추적성 그래프**: FR-AC-TC 연결 상태 시각화
- **리포트 시스템**: 안전/위험/통계 리포트 자동 생성
- **통계 대시보드**: 프로젝트 전체 통계 및 진척도 시각화
- **상태 관리**: draft → in_review → approved → in_progress → completed

---

## 📋 CLI 명령어

### 기본 명령어

```bash
taskflow init [project-name]   # 프로젝트 초기화
taskflow --help                 # 도움말
```

### PRD 관리

```bash
taskflow prd create "제목"      # PRD 생성
taskflow prd list               # PRD 목록
taskflow prd view <id>          # PRD 조회
taskflow prd edit <id>          # PRD 편집
taskflow prd validate <id>      # 추적성 검증
taskflow prd search <query>     # PRD 검색 (fuzzy search)
taskflow prd archive <id>       # PRD 아카이브
```

### 리포트

```bash
taskflow report safety          # 안전 등급별 리포트
taskflow report risk            # 위험도별 리포트
taskflow report stats           # 통계 대시보드
```

### 칸반 보드

```bash
taskboard                       # TUI 칸반 보드 (단축 명령어)
taskflow board                  # TUI 칸반 보드
taskflow board --area robot     # 필터링
```

---

## 🎨 TUI 칸반 보드

```
┌──────────────────────────────────────────────────────────────┐
│         TaskFlow PRD 칸반 보드                               │
│  총 5개 PRD | 방향키: 이동 | Enter: 상세 | s: 상태변경 | q: 종료  │
└──────────────────────────────────────────────────────────────┘
┌────────┬────────┬────────┬────────┬────────┐
│ 초안   │ 검토중 │ 승인됨 │ 진행중 │ 완료   │
│  (1)   │  (1)   │  (1)   │  (1)   │  (1)   │
├────────┼────────┼────────┼────────┼────────┤
│🔴PRD-001│🟢PRD-002│🟡PRD-003│🟡PRD-004│🟢PRD-005│
│배터리...│충전...  │자동...  │장애물...│원격...  │
└────────┴────────┴────────┴────────┴────────┘
```

**키 바인딩:**
- `←/→` 또는 `h/l`: 컬럼 이동
- `↑/↓` 또는 `k/j`: PRD 선택
- `Enter`: 상세 보기
- `s`: 상태 변경
- `q/ESC`: 종료

---

## 📖 PRD 구조

```markdown
---
id: PRD-001
title_ko: 배터리 온도 감지 기능
status: draft
safety_class: ASIL_D
risk_level: high
owner: '@pm'
---

## 개요
...

## 기능 요구사항
- **FR-1** [must]: 배터리 온도 센서 데이터 수집

## 승인 기준
- [ ] AC-1: 온도 데이터가 1초마다 수집됨

## 테스트 케이스
- **TC-1**: 온도 데이터 수집 테스트 (verifies: FR-1, AC-1)
```

---

## 🔍 추적성 검증

```bash
taskflow prd validate PRD-001 --graph

# 출력 예시:
✅ 추적성 검증 결과

📊 커버리지
  FR 커버리지: 100% (3/3)
  AC 커버리지: 100% (3/3)
  TC 커버리지: 66% (2/3)

📈 추적성 그래프
  FR-1 ──┬─→ AC-1 ──→ TC-1
         └─→ AC-2 ──→ TC-2
  FR-2 ────→ AC-3
```

---

## 📊 통계 대시보드

```bash
taskflow report stats

# 출력 예시:
📊 TaskFlow 프로젝트 통계 대시보드

═══════════════════════════════════════════════════════════
  📈 전체 요약
═══════════════════════════════════════════════════════════
  총 PRD 개수: 25개
  완료율: 64.0% (16/25개)

───────────────────────────────────────────────────────────
  📝 상태별 분포
───────────────────────────────────────────────────────────
  초안          ████░░░░░░░░░░ 16.0% (4개)
  진행중        ████████░░░░░░ 32.0% (8개)
  완료          ████████████████ 64.0% (16개)

───────────────────────────────────────────────────────────
  🛡️  안전 등급별 분포
───────────────────────────────────────────────────────────
  ASIL D        ████░░░░░░░░░░ 20.0% (5개)
  ASIL C        ██████░░░░░░░░ 24.0% (6개)
  QM            ████████████░░ 56.0% (14개)

───────────────────────────────────────────────────────────
  💡 권장 사항
───────────────────────────────────────────────────────────
  ✅ 프로젝트가 건강한 상태입니다!
```

---

## 🛠️ 시스템 요구사항

- **Node.js**: >= 18.0.0
- **npm**: >= 9.0.0
- **운영체제**: Linux, macOS, Windows (WSL2 권장)

---

## 📚 문서

- [설치 가이드](./INSTALL.md) - 상세 설치 및 문제 해결
- [배포 가이드](./RELEASE.md) - npm 배포 프로세스
- [변경 이력](./CHANGELOG.md) - 버전별 변경사항
- [AI Instructions](./TASKFLOW.md) - AI 에이전트용 가이드
- [Phase 2 완료](./PHASE2_COMPLETE.md) - 추적성 검증
- [Phase 3 완료](./PHASE3_COMPLETE.md) - 리포트 시스템
- [Phase 4 완료](./PHASE4_COMPLETE.md) - TUI & 고급 기능
- [구현 현황](./IMPLEMENTATION_STATUS.md) - 전체 구현 현황

---

## 🤝 기여

기여를 환영합니다!

```bash
git clone https://github.com/your-org/taskflow.git
cd taskflow
npm install
npm run dev
```

---

## 📄 라이선스

MIT License - [LICENSE](LICENSE) 파일을 참조하세요.

---

## 🙏 감사의 말

- **Backlog.md** - 마크다운 기반 태스크 관리 아이디어
- **vscode-kanbn** - VSCode 칸반 보드 구현 참고
- 로봇 개발 팀의 실제 PRD 관리 요구사항 반영

---

**Made with ❤️ for Robot Developers**