Skip to content

Commit f7a8bc3

Browse files
web-flowclaude
web-flow
and
claude
committed
docs: fix documentation quality issues (8.4→9.0+)
- Fix Loop naming format in digest-setup/SKILL.md (Loop0001→L00001) - Fix relative path in digest-analyzer.md (../→../../) - Add path format guide to README.md (3 environment types) - Update script paths in commands/digest.md (Plugins/→scripts/) - Specify API reference in GUIDE.md (→api/config.md) - Fix regex patterns in TROUBLESHOOTING.md (all digit lengths) - Add CHEATSHEET.md for quick reference 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 3401a19 commit f7a8bc3

7 files changed

Lines changed: 134 additions & 27 deletions

File tree

‎EpisodicRAG/README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,18 @@ EpisodicRAGプラグインで使用される専門用語の定義集です。
2929
- スキルやスクリプトはこのディレクトリを基準に動作
3030
- 例: `C:\Users\anyth\.claude\plugins\marketplaces\Plugins-Weave\EpisodicRAG`
3131

32+
### パス形式の違い
33+
34+
EpisodicRAGは環境によって異なるパスを使用します：
35+
36+
| 環境 | パス形式 | 例 |
37+
|------|---------|-----|
38+
| **開発環境** | ソースコード直接 | `plugins-weave/EpisodicRAG/` |
39+
| **マーケットプレース** | `~/.claude/plugins/marketplaces/` | `~/.claude/plugins/marketplaces/Plugins-Weave/EpisodicRAG/` |
40+
| **プラグイン直接インストール** | `~/.claude/plugins/` | `~/.claude/plugins/EpisodicRAG-Plugin@Plugins-Weave/` |
41+
42+
**重要**: 設定ファイル（config.json）やデータは常にインストール先に配置します。開発環境のソースコードディレクトリには配置しないでください。
43+
3244
### base_dir
3345
**定義**: データ配置の基準ディレクトリ
3446

‎EpisodicRAG/agents/digest-analyzer.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -471,7 +471,7 @@ Grep(pattern="emotional error", path=loops_path, output_mode="files_with_matches
471471

472472
### 2. まだらボケ回避
473473

474-
> 📖 まだらボケの詳細定義は [用語集](../README.md#まだらボケ) を参照
474+
> 📖 まだらボケの詳細定義は [用語集](../../README.md#まだらボケ) を参照
475475
476476
**ShadowGrandDigest 特有の重要概念**:
477477

‎EpisodicRAG/commands/digest.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ TodoWrite({
113113

114114
1. **generate_digest_auto.sh 実行**
115115
```bash
116-
cd Plugins/EpisodicRAG/scripts
116+
cd scripts
117117
bash generate_digest_auto.sh
118118
```
119119

@@ -163,7 +163,7 @@ bash generate_digest_auto.sh
163163
```
164164
- save_provisional_digest.py実行:
165165
```bash
166-
cd Plugins/EpisodicRAG/scripts
166+
cd scripts
167167
python3 save_provisional_digest.py weekly '<individual_digests JSON>' --append
168168
```
169169
- **--append**: 既存Provisionalファイルに追加（複数回/digestでLoopを追加する場合）
@@ -192,7 +192,7 @@ bash generate_digest_auto.sh
192192

193193
1. **generate_digest_auto.sh 実行**
194194
```bash
195-
cd Plugins/EpisodicRAG/scripts
195+
cd scripts
196196
bash generate_digest_auto.sh {{type}}
197197
```
198198

@@ -258,7 +258,7 @@ bash generate_digest_auto.sh {{type}}
258258
```
259259
- save_provisional_digest.py実行:
260260
```bash
261-
cd Plugins/EpisodicRAG/scripts
261+
cd scripts
262262
python3 save_provisional_digest.py {{next_level}} '<individual_digests JSON>'
263263
```
264264
- **注**: 次階層用は新規作成なので --append なし
@@ -280,7 +280,7 @@ bash generate_digest_auto.sh {{type}}
280280

281281
6. **finalize_from_shadow.py 実行**
282282
```bash
283-
cd Plugins/EpisodicRAG/scripts
283+
cd scripts
284284
python3 finalize_from_shadow.py {{type}} "承認されたタイトル"
285285
```
286286
このコマンドが実行する処理:
@@ -311,7 +311,7 @@ python3 finalize_from_shadow.py {{type}} "承認されたタイトル"
311311
```
312312
- save_provisional_digest.py実行:
313313
```bash
314-
cd Plugins/EpisodicRAG/scripts
314+
cd scripts
315315
python3 save_provisional_digest.py <next_level> '<individual_digests JSON>'
316316
```
317317
- 次階層Provisionalファイル作成:
@@ -379,9 +379,9 @@ python3 finalize_from_shadow.py {{type}} "承認されたタイトル"
379379
## 詳細仕様
380380

381381
**完全な仕様とプロセスフロー**:
382-
- `Plugins/EpisodicRAG/scripts/generate_digest_auto.sh`
383-
- `Plugins/EpisodicRAG/agents/digest-analyzer.md`
384-
- `Plugins/EpisodicRAG/.claude-plugin/config.json`
382+
- `scripts/generate_digest_auto.sh`
383+
- `agents/digest-analyzer.md`
384+
- `.claude-plugin/config.json`
385385

386386
**要件**:
387387
- Claude Opus 4.5（Task tool, Subagent機能）
@@ -398,7 +398,7 @@ python3 finalize_from_shadow.py {{type}} "承認されたタイトル"
398398

399399
1. **Bash tool**: スクリプト実行
400400
```python
401-
Bash(command="cd Plugins/EpisodicRAG/scripts && bash generate_digest_auto.sh")
401+
Bash(command="cd scripts && bash generate_digest_auto.sh")
402402
```
403403

404404
2. **Task tool**: DigestAnalyzerエージェント起動
@@ -423,15 +423,15 @@ python3 finalize_from_shadow.py {{type}} "承認されたタイトル"
423423
3. **Edit tool**: ShadowGrandDigest.txt更新
424424
```python
425425
Edit(
426-
file_path="Plugins/EpisodicRAG/data/Essences/ShadowGrandDigest.txt",
426+
file_path="data/Essences/ShadowGrandDigest.txt",
427427
old_string='PLACEHOLDER...',
428428
new_string='{"digest": {...}}'
429429
)
430430
```
431431

432432
4. **Read tool**: 結果確認
433433
```python
434-
Read(file_path="Plugins/EpisodicRAG/data/Essences/GrandDigest.txt")
434+
Read(file_path="data/Essences/GrandDigest.txt")
435435
```
436436

437437
### 引数の取得

‎EpisodicRAG/docs/user/CHEATSHEET.md‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
[EpisodicRAG](../../README.md) > [Docs](../README.md) > CHEATSHEET
2+
3+
# EpisodicRAG クイックリファレンス
4+
5+
1ページで主要機能を参照できるチートシートです。
6+
7+
---
8+
9+
## コマンド早見表
10+
11+
| コマンド | 用途 | 使用タイミング |
12+
|---------|------|---------------|
13+
| `/digest` | 新規Loop検出・分析 | Loopを追加したら都度 |
14+
| `/digest weekly` | Weekly Digest確定 | 5個のLoopが揃ったら |
15+
| `/digest monthly` | Monthly Digest確定 | 5個のWeeklyが揃ったら |
16+
17+
## スキル早見表
18+
19+
| スキル | 用途 |
20+
|--------|------|
21+
| `@digest-auto` | システム状態診断・推奨アクション |
22+
| `@digest-setup` | 初期セットアップ |
23+
| `@digest-config` | 設定変更 |
24+
25+
---
26+
27+
## ファイル命名規則
28+
29+
| 種類 | プレフィックス | 桁数 | 形式 | 例 |
30+
|------|---------------|------|------|-----|
31+
| Loop | L | 5 | `L[5桁]_タイトル.txt` | `L00001_初回セッション.txt` |
32+
| Weekly | W | 4 | `日付_W[4桁]_タイトル.txt` | `2025-01-01_W0001_週次まとめ.txt` |
33+
| Monthly | M | 4 | `日付_M[4桁]_タイトル.txt` | `2025-02-01_M0001_月次まとめ.txt` |
34+
| Quarterly | Q | 3 | `日付_Q[3桁]_タイトル.txt` | `2025-04-01_Q001_四半期.txt` |
35+
36+
---
37+
38+
## デフォルト閾値
39+
40+
| 階層 | 必要数 | 累積Loop数 |
41+
|------|--------|-----------|
42+
| Weekly | 5 Loops | 5 |
43+
| Monthly | 5 Weekly | 25 |
44+
| Quarterly | 3 Monthly | 75 |
45+
| Annual | 4 Quarterly | 300 |
46+
47+
---
48+
49+
## 主要パス
50+
51+
| 項目 | パス |
52+
|------|------|
53+
| 設定ファイル | `.claude-plugin/config.json` |
54+
| Loopファイル | `{loops_dir}/` |
55+
| Digestファイル | `{digests_dir}/` |
56+
| GrandDigest | `{essences_dir}/GrandDigest.txt` |
57+
| ShadowGrandDigest | `{essences_dir}/ShadowGrandDigest.txt` |
58+
59+
---
60+
61+
## 日常ワークフロー
62+
63+
```text
64+
毎日: Loop追加 → /digest
65+
週末: @digest-auto → /digest weekly
66+
月末: @digest-auto → /digest monthly
67+
```
68+
69+
---
70+
71+
## トラブル時
72+
73+
1. `@digest-auto` で状態確認
74+
2. [TROUBLESHOOTING.md](TROUBLESHOOTING.md) で具体的な解決策
75+
3. [FAQ.md](FAQ.md) で概念的な疑問
76+
77+
---
78+
79+
## 関連ドキュメント
80+
81+
| 目的 | ドキュメント |
82+
|------|-------------|
83+
| 初めての方 | [QUICKSTART.md](QUICKSTART.md) |
84+
| 日常操作 | [GUIDE.md](GUIDE.md) |
85+
| 高度な設定 | [ADVANCED.md](ADVANCED.md) |
86+
| 用語集 | [README.md](../../README.md) |
87+
88+
---
89+
**EpisodicRAG** by Weave | [GitHub](https://github.com/Bizuayeu/Plugins-Weave)

‎EpisodicRAG/docs/user/GUIDE.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ flowchart TD
183183
| `levels.weekly_threshold` | Weekly生成に必要なLoop数 | `5` |
184184
| `levels.monthly_threshold` | Monthly生成に必要なWeekly数 | `5` |
185185

186-
> 📖 完全な設定仕様は [API_REFERENCE.md](../dev/API_REFERENCE.md) を参照
186+
> 📖 完全な設定仕様は [api/config.md](../dev/api/config.md) を参照
187187
188188
### パス設定について
189189

‎EpisodicRAG/docs/user/TROUBLESHOOTING.md‎

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -422,13 +422,19 @@ git status
422422
```bash
423423
cd {loops_dir}
424424

425-
# PowerShell (Windows) - Loop0001 → L00001
426-
Get-ChildItem -Filter "Loop???_*.txt" | Rename-Item -NewName { $_.Name -replace '^Loop(\d{3})_', 'L00$1_' }
427-
Get-ChildItem -Filter "Loop????_*.txt" | Rename-Item -NewName { $_.Name -replace '^Loop(\d{4})_', 'L0$1_' }
425+
# PowerShell (Windows) - 全桁数対応（Loop1〜Loop99999 → L00001〜L99999）
426+
Get-ChildItem -Filter "Loop*_*.txt" | ForEach-Object {
427+
$newName = $_.Name -replace '^Loop(\d+)_', { 'L' + $_.Groups[1].Value.PadLeft(5, '0') + '_' }
428+
Rename-Item $_.FullName -NewName $newName
429+
}
428430

429-
# Bash (macOS/Linux) - Loop0001 → L00001
430-
for f in Loop???_*.txt; do mv "$f" "L00${f#Loop}"; done
431-
for f in Loop????_*.txt; do mv "$f" "L0${f#Loop}"; done
431+
# Bash (macOS/Linux) - 全桁数対応
432+
for f in Loop*_*.txt; do
433+
num=$(echo "$f" | sed 's/Loop\([0-9]*\)_.*/\1/')
434+
rest=$(echo "$f" | sed 's/Loop[0-9]*_//')
435+
newname=$(printf "L%05d_%s" "$num" "$rest")
436+
mv "$f" "$newname"
437+
done
432438
```
433439
434440
**方法2: 手動リネーム**

‎EpisodicRAG/skills/digest-setup/SKILL.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -348,18 +348,18 @@ Threshold設定:
348348
Claude/ChatGPTの会話を丸ごと保存できます。
349349
350350
**Loop命名ルール：**
351-
- 形式: `Loop[連番]_[タイトル].txt`
352-
- 連番: 4桁以上の数字（大きいほど新しい記録）
351+
- 形式: `L[連番]_[タイトル].txt`
352+
- 連番: 5桁の数字（大きいほど新しい記録）
353353
- タイトル: 英数字、日本語、ハイフン、アンダースコアなど
354-
- 正規表現: `^Loop[0-9]+_[\p{L}\p{N}ー・\w]+\.txt$`
354+
- 正規表現: `^L[0-9]+_[\p{L}\p{N}ー・\w]+\.txt$`
355355
356356
例:
357-
Loop0001_初回セッション.txt
358-
Loop0002_プロジェクト設計.txt
359-
Loop0003_実装_Phase1.txt
357+
L00001_初回セッション.txt
358+
L00002_プロジェクト設計.txt
359+
L00003_実装_Phase1.txt
360360
361361
**配置先:**
362-
{loops_dir}/Loop0001_タイトル.txt
362+
{loops_dir}/L00001_タイトル.txt
363363
364364
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
365365

0 commit comments

Comments
 (0)