|
|
7f43a6bfc7
|
docs: 重写 README，中英文对齐，历史移入 CHANGELOG
## 问题：README 像架构文档，不像 README
原文 420 行，开头第一句是「以核心域与应用域分离为设计原则的 Agent 框架」。
读者点进来想知道「这东西能给我干什么」，得到的是一句需要三分钟才能理解的定义。
量化一下 AI 味的几个典型指纹：
| 指标 | 改前 | 改后 |
|---|---|---|
| 加粗标记 | **230** 处 | 56 处 |
| 破折号插入语 | **17** 处 | 0 |
| 行数 | 420 | 204 |
| 「项目状态」占比 | 86 行（21%） | 移出 |
几乎每条 bullet 都是同一个模板：粗体术语开头 + 三行解释 + 收尾总结。
结构过度对称、每段都自我收尾，是 AI 写作最明显的痕迹。
## 改法：先说人话，再讲设计
开头四句：
> 一个能自己跑几个月、还记得住事的 Agent 内核。
> 说人话：你给它接上 QQ、WebUI、命令行、文件、浏览器，它就能在这些地方替你干活。
> 白天聊过的事，晚上还记得。三周前说过的偏好，不会因为上下文窗口滚动就丢了。
> 插件崩了它不倒，模型换了它不改。
然后把 `## 设计要点` 改成 `## 它跟别的 Agent 框架哪里不一样` ——从「我们有什么设计」
改成「你和别人有什么不同」。每条都给了**为什么这么选**，不是**我们做得多好**：
- 插件是独立进程 → 因为 `.so` 那套踩过 `dlclose` 空操作、cgo 超时杀不掉线程
- 内核不碰 IO → 好处不是干净，是能换掉整个交互层而不改内核
- 记忆会下沉 → 所以能跑几个月而不把历史全塞进 prompt
`## 能力` 不列 API，列「你能让它干什么」：说话的地方 / 看和听 / 动手 / 记住 / 调度。
## 删掉 227 行重复与历史
- **`## 架构图`（142 行）**：`ARCHITECTURE.md` 里已有完整的「消息处理流程」「7 阶段
钩子」「三层记忆」，README 里这套是**逐字重复**。README 留一张 8 行流程图 +
三段话讲清机制，细节指向架构文档。
- **`## 项目状态`（85 行）**：这是更新日志，不是 README。移入新建的
`CHANGELOG.md` / `CHANGELOG_EN.md`。
## 中英文同步
`README_EN.md` 之前停在旧版式（439 行，含 `Architecture Diagrams` /
`Project Status`），与中文版结构完全不同 —— 不是这次才不同步，是**一直是两份不同的文档**。
本次按节 1:1 对齐（9 节完全一致），英文不是逐字直译，按英文习惯重写：
```
## 它跟别的 Agent 框架哪里不一样 → ## What makes it different
## 能力 → ## What it can do
## 怎么工作的 → ## How it works
## 快速体验 → ## Quick Start
## 代码结构 → ## Code Structure
...
```
补上英文版一直**缺失**的 `## Quick Start` 整节（中文有、英文没有）。
## 顺带修正的事实错误
- 「内置 13 个插件」→ 实际 18 个插件目录（`webui`/`cli`/`files`/`cmd`/`mcp`/`kbtree`/`seq`/`skillmgr` …）
- 「参考 `example/` 目录下的 Go 和 Lua 示例」→ 26 个插件已迁到
[github.com/HologramAgent](https://github.com/HologramAgent)，`example/` 只剩 2 个
## 验证
- 两版死链检查：`README.md` / `README_EN.md` 内部链接全部有效
- 9 个二级标题逐一对齐
- 破折号插入语归零（英文剩余 4 处全是列表分隔符）
|
2026-10-31 11:08:12 +08:00 |
|
