Skip to content

Commit 7f391c5

Browse files
solzipclaude
andcommitted
docs: FAQ 3종 + 로드맵 Phase E/F 추가
- FAQ: git log 차별점, Cursor 지원 계획, SQLite 전환 계획 - 로드맵: Phase E (멀티 IDE), Phase F (SQLite + 전문 검색) - 커뮤니티 포스팅 템플릿에 FAQ 반영 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 71caf5d commit 7f391c5

File tree

3 files changed

+38
-2
lines changed

3 files changed

+38
-2
lines changed

README.en.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,14 +200,30 @@ claude-diary team weekly # Team weekly report
200200
- Please output clear summaries when completing/implementing/fixing tasks
201201
```
202202

203+
## FAQ
204+
205+
**"Isn't `git log` enough?"**
206+
207+
git log records *what you committed*. claude-diary records *what you tried, asked for, and debugged* — including sessions where you didn't commit anything. It captures the original prompts ("implement JWT auth"), commands run, errors encountered, and time spent. Think of it as the gap between your commit history and your actual workday.
208+
209+
**"Does it work with Cursor / Windsurf / Copilot?"**
210+
211+
Not yet — currently Claude Code only (via Stop Hook). But the core pipeline just needs `session_id + transcript + cwd`, so adding other AI IDEs is architecturally straightforward. See roadmap below.
212+
213+
**"Why JSON index instead of SQLite?"**
214+
215+
The current JSON index is simple and has zero dependencies. SQLite (which is in Python's stdlib) is planned for v5.0 to enable full-text search and faster queries across months of data.
216+
203217
## Roadmap
204218

205219
| Phase | Goal | Version | Status |
206220
|-------|------|---------|--------|
207221
| **A** | Personal productivity (categories, Git, CLI, plugins, dashboard) | v2.0.0 | ✅ Done |
208-
| **B** | Open source community (security, 40 tests, CI/CD) | v3.0.0 | ✅ Done |
222+
| **B** | Open source community (security, 420+ tests, CI/CD) | v3.0.0 | ✅ Done |
209223
| **C** | Team/company tool (access control, central repo, team reports) | v4.0.0 | ✅ Done |
210224
| **D** | Distribution (plugin, PyPI, marketplace) | v4.1.0 | ✅ Done |
225+
| **E** | Multi-IDE support (Cursor, Windsurf, VS Code extension) | v5.0.0 | 📋 Planned |
226+
| **F** | SQLite index + full-text search + analytics API | v5.1.0 | 📋 Planned |
211227

212228
See [`docs/plans/`](docs/plans/) for detailed roadmaps.
213229

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,14 +200,30 @@ claude-diary team weekly # 팀 주간 리포트
200200
- 작업 완료/구현/수정 시 명확한 요약을 출력해주세요
201201
```
202202

203+
## FAQ
204+
205+
**"git log로 충분하지 않나요?"**
206+
207+
git log는 *커밋한 것*을 기록합니다. claude-diary는 *시도한 것, 요청한 것, 디버깅한 것*을 기록합니다 — 커밋 없이 끝난 세션도 포함해서요. "JWT 인증 구현해줘" 같은 원래 요청, 실행한 명령어, 발생한 에러, 소요 시간까지. 커밋 이력과 실제 하루 사이의 빈 공간을 채워줍니다.
208+
209+
**"Cursor / Windsurf / Copilot에서도 되나요?"**
210+
211+
아직은 Claude Code 전용입니다 (Stop Hook 기반). 하지만 핵심 파이프라인은 `session_id + transcript + cwd`만 있으면 되기 때문에, 다른 AI IDE 지원은 구조적으로 어렵지 않습니다. 아래 로드맵을 참고하세요.
212+
213+
**"JSON 인덱스 말고 SQLite는요?"**
214+
215+
현재 JSON 인덱스는 단순하고 의존성이 없습니다. SQLite는 Python 표준 라이브러리에 포함되어 있어 여전히 의존성 0을 유지하면서, 전문 검색과 수개월 데이터 쿼리 성능을 개선할 수 있습니다. v5.0에서 계획 중입니다.
216+
203217
## 로드맵
204218

205219
| Phase | 목표 | 버전 | 상태 |
206220
|-------|------|------|------|
207221
| **A** | 개인 생산성 도구 (카테고리, Git, CLI, 플러그인, 대시보드) | v2.0.0 | ✅ 완료 |
208-
| **B** | 오픈소스 커뮤니티 (보안, 테스트 40개, CI/CD) | v3.0.0 | ✅ 완료 |
222+
| **B** | 오픈소스 커뮤니티 (보안, 테스트 420+개, CI/CD) | v3.0.0 | ✅ 완료 |
209223
| **C** | 팀/회사 도구 (접근 제어, Git 중앙 repo, 팀 리포트) | v4.0.0 | ✅ 완료 |
210224
| **D** | 배포 (플러그인, PyPI, 마켓플레이스) | v4.1.0 | ✅ 완료 |
225+
| **E** | 멀티 IDE 지원 (Cursor, Windsurf, VS Code 확장) | v5.0.0 | 📋 예정 |
226+
| **F** | SQLite 인덱스 + 전문 검색 + 분석 API | v5.1.0 | 📋 예정 |
211227

212228
자세한 내용은 [`docs/plans/`](docs/plans/) 디렉토리를 참고하세요.
213229

docs/community-posts.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,10 @@ That's it. Every Claude Code session now auto-generates entries like this:
4343
- `claude-diary search "keyword"` — search across months of work
4444
- Team mode with access control and central repo
4545

46+
**"Isn't git log enough?"** — git log records what you committed. This records what you *asked for*, *tried*, and *debugged* — including sessions where you committed nothing.
47+
48+
**Coming next:** Cursor/Windsurf/VS Code support (v5.0), SQLite full-text search (v5.1)
49+
4650
GitHub: https://github.com/solzip/claude-code-hooks-diary
4751

4852
MIT licensed, Python 3.8+, zero dependencies. Feedback welcome!

0 commit comments

Comments
 (0)