tuzi-update-claude-md

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Update CLAUDE.md

更新 CLAUDE.md

Analyzes code review feedback or development issues, extracts general rules, and updates documentation with a layered strategy (summary in CLAUDE.md, details in docs/CODING_RULES.md).

分析代码审查反馈或开发过程中遇到的问题，提取通用规则，并采用分层策略更新文档（摘要放在CLAUDE.md中，详细内容放在docs/CODING_RULES.md中）。

Core Principle

核心原则

CLAUDE.md must stay concise. Summary rules only, 1-2 sentences each.

Document	Content	Line Limit
`CLAUDE.md`	Core summary rules (1-2 sentences)	≤ 300 lines
`docs/CODING_RULES.md`	Detailed rules + error/correct examples	No limit
`docs/FEATURE_FLOWS.md`	Feature flow documentation	No limit

CLAUDE.md 必须保持简洁。仅存放规则摘要，每条规则摘要1-2句话即可。

文档	内容	行数限制
`CLAUDE.md`	核心规则摘要（1-2句话）	≤ 300 行
`docs/CODING_RULES.md`	详细规则 + 错误/正确示例	无限制
`docs/FEATURE_FLOWS.md`	功能流程文档	无限制

Parameters

参数

```
$ARGUMENTS
```
: Description of the discovered issue or rule (optional)

```
$ARGUMENTS
```
: 发现的问题或规则的描述（可选）

Preferences (EXTEND.md)

偏好设置（EXTEND.md）

Use Bash to check EXTEND.md existence (priority order):

bash

undefined

使用Bash检查EXTEND.md是否存在（优先级顺序如下）：

bash

undefined

Check project-level first

test -f .tuzi-skills/tuzi-update-claude-md/EXTEND.md && echo "project"

Then user-level (cross-platform: $HOME works on macOS/Linux/WSL)

test -f "$HOME/.tuzi-skills/tuzi-update-claude-md/EXTEND.md" && echo "user"


┌──────────────────────────────────────────────────────────┬───────────────────┐
│                           Path                           │     Location      │
├──────────────────────────────────────────────────────────┼───────────────────┤
│ .tuzi-skills/tuzi-update-claude-md/EXTEND.md            │ Project directory │
├──────────────────────────────────────────────────────────┼───────────────────┤
│ $HOME/.tuzi-skills/tuzi-update-claude-md/EXTEND.md      │ User home         │
└──────────────────────────────────────────────────────────┴───────────────────┘

┌───────────┬───────────────────────────────────────────────────────────────────────────┐
│  Result   │                                  Action                                   │
├───────────┼───────────────────────────────────────────────────────────────────────────┤
│ Found     │ Read, parse, apply settings                                               │
├───────────┼───────────────────────────────────────────────────────────────────────────┤
│ Not found │ Use defaults                                                              │
└───────────┴───────────────────────────────────────────────────────────────────────────┘

**EXTEND.md Supports**: CLAUDE.md line limit | Rule categories | Commit message format

test -f "$HOME/.tuzi-skills/tuzi-update-claude-md/EXTEND.md" && echo "user"


┌──────────────────────────────────────────────────────────┬───────────────────┐
│                           路径                           │        位置       │
├──────────────────────────────────────────────────────────┼───────────────────┤
│ .tuzi-skills/tuzi-update-claude-md/EXTEND.md            │ 项目目录           │
├──────────────────────────────────────────────────────────┼───────────────────┤
│ $HOME/.tuzi-skills/tuzi-update-claude-md/EXTEND.md      │ 用户根目录         │
└──────────────────────────────────────────────────────────┴───────────────────┘

┌───────────┬───────────────────────────────────────────────────────────────────────────┐
│   结果    │                                  操作                                   │
├───────────┼───────────────────────────────────────────────────────────────────────────┤
│ 找到      │ 读取、解析并应用配置                                               │
├───────────┼───────────────────────────────────────────────────────────────────────────┤
│ 未找到    │ 使用默认配置                                                              │
└───────────┴───────────────────────────────────────────────────────────────────────────┘

**EXTEND.md 支持配置项**: CLAUDE.md行数限制 | 规则分类 | 提交信息格式

Workflow

工作流程

Step 1: Gather Information

步骤1：收集信息

If
$ARGUMENTS
provided: Parse the described issue or rule.

If no arguments: Ask user what issue was discovered, or check recent git diff and commit messages:

bash

git diff HEAD~3 --stat
git log --oneline -5

如果提供了
$ARGUMENTS
：解析描述的问题或规则。

如果没有提供参数：询问用户发现了什么问题，或者查看最近的git diff和提交记录：

bash

git diff HEAD~3 --stat
git log --oneline -5

Step 2: Assess Rule Priority

步骤2：评估规则优先级

Priority	Criteria	Action
High	Frequent error pattern, causes serious bugs, core project convention	Add to both CLAUDE.md + CODING_RULES.md
Normal	Occasional issue, scenario-specific, detailed examples	Only CODING_RULES.md
Skip	One-off typo, overly specific business logic, already covered	Do not record

优先级	判断标准	操作
高	高频错误模式，会导致严重bug，属于项目核心约定	同时添加到CLAUDE.md + CODING_RULES.md
中	偶发问题，特定场景下出现，需要详细示例	仅添加到CODING_RULES.md
跳过	一次性笔误，过于特定的业务逻辑，已有规则覆盖	无需记录

Step 3: Check Document Status

步骤3：检查文档状态

bash

wc -l CLAUDE.md

If over 250 lines, prompt user to clean up before adding.

bash

wc -l CLAUDE.md

如果超过250行，提示用户先清理内容再添加新规则。

Step 4: Update docs/CODING_RULES.md

步骤4：更新docs/CODING_RULES.md

Add to the appropriate section using this format:

markdown

undefined

使用如下格式添加到对应章节：

markdown

undefined

[Issue Title]

Scenario: [When this issue occurs]

❌ Wrong: ```typescript // incorrect code ```

✅ Correct: ```typescript // correct code ```

Reason: [Why]


**Section categories**: TypeScript | React Components | Service Worker | Cache & Storage | API & Task Processing | UI Interaction

Scenario: [When this issue occurs]

❌ Wrong:

typescript

// incorrect code

✅ Correct:

typescript

// correct code

Reason: [Why]


**章节分类**: TypeScript | React Components | Service Worker | Cache & Storage | API & Task Processing | UI Interaction

Step 5: Update CLAUDE.md (High Priority Only)

步骤5：更新CLAUDE.md（仅高优先级规则）

Add 1-2 sentence summary only:

markdown

N. **Rule Name**: Brief description (1-2 sentences)

Location: Under

## 核心编码规则

or equivalent section.

仅添加1-2句话的摘要：

markdown

N. **Rule Name**: Brief description (1-2 sentences)

添加位置：

## 核心编码规则

或对应章节下方。

Step 6: Check for Duplicates

步骤6：检查重复规则

Check both CLAUDE.md and CODING_RULES.md for similar existing rules
Supplement existing rules rather than creating new ones
Avoid document bloat from redundancy

检查CLAUDE.md和CODING_RULES.md中是否已有相似规则
补充现有规则而非新建规则
避免冗余导致的文档臃肿

Step 7: Confirm Update

步骤7：确认更新

Display summary:

undefined

展示更新摘要：

undefined

Documentation Updated

docs/CODING_RULES.md

Section: [section name]
Added: [rule description]
Includes: Error/correct examples + explanation

Section: [section name]
Added: [rule description]
Includes: Error/correct examples + explanation

CLAUDE.md (if applicable)

Section: [section name]
Added summary: [rule summary]

Section: [section name]
Added summary: [rule summary]

Document Status

CLAUDE.md: XXX lines (limit 300) ✅/⚠️
CODING_RULES.md: XXX lines

undefined

CLAUDE.md: XXX lines (limit 300) ✅/⚠️
CODING_RULES.md: XXX lines

undefined

Step 8: Commit

步骤8：提交代码

bash

git add CLAUDE.md docs/CODING_RULES.md
git commit -m "docs: add coding rule - [rule name]"

bash

git add CLAUDE.md docs/CODING_RULES.md
git commit -m "docs: add coding rule - [rule name]"

Periodic Cleanup

定期清理

When CLAUDE.md approaches 300 lines:

Merge similar rules
Remove outdated rules
Move overly detailed rules to CODING_RULES.md
Update cross-references

当CLAUDE.md接近300行时：

合并相似规则
移除过时规则
将过于详细的规则迁移到CODING_RULES.md中
更新交叉引用

Example Usage

使用示例

bash

undefined

bash

undefined

With argument

/tuzi-update-claude-md Claude keeps forgetting to add theme='light' to TDesign Tooltip

Interactive

/tuzi-update-claude-md

undefined

/tuzi-update-claude-md

undefined

Extension Support

扩展支持

Custom configurations via EXTEND.md. See Preferences section for paths and supported options.

可通过EXTEND.md进行自定义配置。路径和支持的配置项参见偏好设置章节。