rewrite all docs in English
This commit is contained in:
@@ -1,49 +1,49 @@
|
||||
# improve-skills
|
||||
|
||||
当发现现有 skill 或 workflow 存在以下问题时使用:
|
||||
Used when a skill or workflow has one of these problems:
|
||||
|
||||
- 有误导或歧义
|
||||
- 没有覆盖到你的使用情景
|
||||
- 效果不理想
|
||||
- Misleading or ambiguous
|
||||
- Missing coverage for your use case
|
||||
- Suboptimal or confusing behavior
|
||||
|
||||
## 原则
|
||||
## Principle
|
||||
|
||||
改进比 work-around 更好。发现问题时及时修正,避免后续其他人踩同样的坑。
|
||||
Improvement is better than workaround. Fix problems when you find them, so others don't hit the same坑.
|
||||
|
||||
## 流程
|
||||
## Process
|
||||
|
||||
### 1. 识别问题
|
||||
### 1. Identify the Problem
|
||||
|
||||
- 记录哪个 skill 的哪个部分有问题
|
||||
- 具体描述:哪里误导、哪里缺失、哪里效果差
|
||||
- 记录触发场景:什么情况下发现这个问题
|
||||
- Record which skill and which part has the issue
|
||||
- Describe specifically: what's misleading, what's missing, what's not working well
|
||||
- Record the scenario where you encountered it
|
||||
|
||||
### 2. 评估影响范围
|
||||
### 2. Assess Impact
|
||||
|
||||
- 这个问题会影响多少人?
|
||||
- 是 skill 设计问题还是描述/文档问题?
|
||||
- 修复复杂度如何?
|
||||
- How many people will this affect?
|
||||
- Is it a design issue or a documentation issue?
|
||||
- What's the complexity of the fix?
|
||||
|
||||
### 3. 确定改进方案
|
||||
### 3. Design the Fix
|
||||
|
||||
- **文档问题** → 改 SKILL.md 或相关描述
|
||||
- **逻辑缺陷** → 修改脚本或 skill 逻辑
|
||||
- **覆盖缺失** → 新增流程或脚本
|
||||
- **流程不顺** → 重新设计 workflow
|
||||
- **Documentation issue** → update SKILL.md or related descriptions
|
||||
- **Logic flaw** → modify the script or skill logic
|
||||
- **Missing coverage** → add a new workflow or script
|
||||
- **Process issue** → redesign the workflow
|
||||
|
||||
### 4. 执行改进
|
||||
### 4. Implement
|
||||
|
||||
- 在本地或分支上修改
|
||||
- 更新 SKILL.md(如果改了描述)
|
||||
- 如果改动较大,先在本地测试
|
||||
- Make changes locally or on a branch
|
||||
- Update SKILL.md if behavior changed
|
||||
- Test if the change is significant
|
||||
|
||||
### 5. 提交
|
||||
### 5. Submit
|
||||
|
||||
- 按 promote-improvements 流程提交到自己的分支
|
||||
- commit message 说明改进内容
|
||||
- 附上问题描述和解决思路(便于 hang review)
|
||||
- Follow promote-improvements to push to your branch
|
||||
- Commit message should describe what was changed and why
|
||||
- Include problem description and fix rationale for hang's review
|
||||
|
||||
### 6. 通知 hang
|
||||
### 6. Notify hang
|
||||
|
||||
- 完成后告知 hang,说明改了什么、为什么改
|
||||
- 让 hang 决定是 merge 还是继续调整
|
||||
- After completion, tell hang what was changed and why
|
||||
- Let hang decide whether to merge or iterate further
|
||||
|
||||
Reference in New Issue
Block a user