documentation-updates

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Documentation Updates

文档更新

Update documentation based on lessons learned from the conversation.

根据对话中吸取的经验教训更新文档。

When to Use This Skill

何时使用该Skill

Use this skill when:

You made a mistake or misunderstanding that could have been prevented
You discovered something that should be documented for future reference
The user asks you to "reflect" on what happened
After completing work where documentation gaps were discovered

使用该Skill的场景：

你犯了本可以避免的错误或产生了本可避免的误解
你发现了需要记录下来以供未来参考的内容
用户要求你对发生的事情进行“复盘”
完成工作后发现存在文档缺口

Process

流程

Momentarily pause any other actions to review the conversation and reflect on any mistakes or misunderstandings. Update any/all of the following as appropriate:

暂时暂停所有其他操作，回顾对话，反思所有错误或误解。根据实际情况更新以下任意/全部内容：

Files to Update

需要更新的文件

Project-level documentation:
- ```
AGENTS.md
```
  in the current project
- ```
CLAUDE.md
```
  in the current project
- Any project-specific documentation
Global documentation:
- Global
```
AGENTS.md
```
  (
```
~/.claude/AGENTS.md
```
  or similar)
- Global
```
CLAUDE.md
```

Agent settings:

Per-project settings (
```
.claude/settings.json
```
,
```
opencode.json
```
)

Global settings (

~/.config/opencode/opencode.json

~/.claude/settings.json

)

Other project documentation:
- README.md
- Design documents
- Architecture guides

项目级文档：
- ```
AGENTS.md
```
  in the current project
- ```
CLAUDE.md
```
  in the current project
- 任何项目专属文档
全局文档：
- 全局
```
AGENTS.md
```
  （
```
~/.claude/AGENTS.md
```
  或类似路径）
- 全局
```
CLAUDE.md
```

Agent设置：

单项目设置（
```
.claude/settings.json
```
,
```
opencode.json
```
）

全局设置（

~/.config/opencode/opencode.json

~/.claude/settings.json

）

其他项目文档：
- README.md
- 设计文档
- 架构指南

What to Document

需要记录的内容

Common pitfalls encountered and how to avoid them
Important constraints or requirements discovered
Useful patterns or approaches found effective
Mistakes made and what should have been done differently
Configuration or setup nuances

遇到的常见陷阱及规避方法
发现的重要约束或需求
被验证有效的实用模式或方法
犯过的错误及正确的处理方式
配置或设置的注意事项

Important Rule

重要规则

Do NOT resume ANY previous actions until the user is satisfied that the docs have been appropriately updated.

在用户确认文档已得到合理更新之前，不得恢复任何之前的操作。

Output

输出

After updating documentation:

List the files that were modified
Summarize the changes made
Confirm with the user that the updates are adequate

更新文档后：

列出所有被修改的文件
总结所做的变更
向用户确认更新是否足够