Skip to content

docs: 重构自述文件定位与结构 - #63

Merged
Aswellle merged 1 commit into
mainfrom
docs/readme-restructure
Oct 18, 2026
Merged

Aswellle merged 1 commit into
mainfrom
docs/readme-restructure

Conversation

@Aswellle

Copy link
Copy Markdown
Owner

改动目的

原自述文件的头部定位是「看到不认识的英文,Ctrl+C」,把项目窄化成了「读英文」这一种场景。实际上它适用于任何语言、任何应用、任何可复制的文字。

主要改动

1. 重新定位头部

  • 主标语从「看到不认识的英文」改为「复制,就是翻译。任何应用,任何语言。」
  • Banner 图片放大到全宽(原 720px 限制浪费了 1672×941 的原图),棱镜分光正好呼应「一种语言折射成多种语言」
  • 徽章下方新增一行关键约束(平台 / 安装包体积 / 空闲内存),让读者在第一屏就知道成本

2. 按热门开源项目的叙事结构重排

参考 Pot、OpenAI Translator、Immersive Translate、CopyTranslator、espanso 等项目的组织方式,从「功能罗列」改为「价值递进」:

原结构 新结构
简介 它解决什么问题(先讲切换成本,再讲定位)
功能特性(大表格) 为什么是它,而不是网页翻译(对比表,建立差异)
安装 / 快速开始 30 秒上手(三步,前置到功能之前)
操作 / 配置 / 可靠性 核心能力(按使用价值分五组)
从源码构建 它为什么不会坏(可靠性叙事)
技术架构 / FAQ 安装 → 快捷键 → 配置 → FAQ → 构建 → 架构

3. 应用场景扩展

明确列出七类真实场景,包含此前完全没提的反向输出(中文写完译成英文再粘贴到邮件/Issue)。

4. 修正事实错误

  • 支持语言数:11 → 12(SUPPORTED_LANGUAGES 实际含简体中文、繁體中文、English、日本語、한국어、Français、Deutsch、Español、Русский、Português、Italiano、العربية)
  • 补充已上线但自述文件未提及的能力:位置记忆、液态玻璃材质、历史分组与相对时间、搜索命中居中
  • 新增 FAQ:是否支持 Linux(如实说明未适配)

5. 中英文同步

两版章节结构一一对应(各 12 个二级章节),英文版按英文技术写作习惯行文而非直译。

校验

  • 所有本地链接(LICENSE、README.en.md、release.yml)均存在
  • HTML 标签闭合平衡,表格语法正确
  • 引用数据(220+ 测试、三平台 CI、5000 字符上限、回退顺序)均与代码核对一致

- 头部定位从「读英文」扩展为「任何应用、任何语言」,覆盖反向外译等场景
- 新增「它解决什么问题」「为什么不是网页翻译」两节,先讲清价值再列功能
- 功能按使用价值分组,安装与上手前置,架构与构建后置
- 修正支持语言数(11 → 12,与 SUPPORTED_LANGUAGES 一致)
- 补充位置记忆、液态玻璃材质、历史分组展示等已上线能力
- 中英文两版结构与章节一一对应
@Aswellle
Aswellle merged commit 26b8480 into main Oct 18, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant