From bba
Improve Chinese technical writing so engineers can read it quickly and trust the meaning. Use when the user asks to polish, rewrite, clarify, simplify, de-jargon, make prose more natural, or improve readability for Chinese technical text, including design docs, specs, proposals, PR descriptions, issues, review comments, READMEs, postmortems, release notes, plans, or AI-generated drafts. Focus on preserving technical meaning while making the structure, logic, wording, and tone clearer.
How this skill is triggered — by the user, by Claude, or both
Slash command
/bba:chinese-tech-plain-writingThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
把中文技术文字改到“工程师一眼能读懂”。适用对象不是某一种文档格式,而是所有需要表达技术判断、方案、变更、风险、步骤或结论的中文 prose。
把中文技术文字改到“工程师一眼能读懂”。适用对象不是某一种文档格式,而是所有需要表达技术判断、方案、变更、风险、步骤或结论的中文 prose。
核心目标:
技术读者通常先找答案:做什么、为什么、影响什么、需要谁行动。把结论放在段首或小节开头。
| 原文 | 改写 |
|---|---|
| 由于当前实现里状态分散在多个入口,后续需求还会继续增加类似判断,所以这里考虑做一次统一收口。 | 建议把状态判断统一收口。原因是当前状态分散在多个入口,后续需求还会继续增加类似判断。 |
| 这个方案整体上可以减少很多复杂度。 | 这个方案把三处重复判断合并到一个入口,后续新增状态时只需要改一处。 |
不要把条件、手段、结果、目的压进一个短语。中文技术文档可以短,但不能让读者猜关系。
| 原文 | 改写 |
|---|---|
| 零改动自动兼容 | 不需要改调用方,现有路径会自动兼容。 |
| 配置驱动多环境发布 | 发布流程由配置决定,因此同一套逻辑可以用于多个环境。 |
| 灰度异常自动回滚 | 灰度期间如果核心指标异常,系统会自动回滚。 |
连续堆术语会让句子像标签。保留必要术语,但补上“谁影响谁、谁依赖谁、谁负责什么”。
| 原文 | 改写 |
|---|---|
| 网关限流 Redis 原子扣减 | 网关用 Redis 记录限流状态,并通过原子扣减避免并发请求绕过限制。 |
| React Suspense 降级兜底 | 在 React Suspense 边界内加载失败或等待时,显示降级 UI 作为兜底。 |
| K8s HPA 自定义指标弹性伸缩 | K8s 的 HPA 根据自定义指标自动扩缩容。 |
代码和术语可以保留英文,但句子本身要像中文。
| 原文 | 改写 |
|---|---|
| bump 版本 | 提升版本号 |
| dispatch 到 parser | 分发给 parser |
| escape 字符串 | 对字符串做转义 |
| deploy 到 staging | 部署到 staging 环境 |
保留 git push、commit、PR、CI、OAuth、PostgreSQL、API 名、函数名、命令和错误信息。不要为了中文化而翻译稳定术语。
如果一句话同时包含背景、动作、目的、结果或例外,拆成两句以上。常见结构:
因为 A,所以 B为了 A,我们做 B如果 A,就 B;否则 C相比 A,B 的代价是 C,但收益是 D删除不提供信息的词:
不要删除有技术含义的限定:
根据用户请求选择输出形态:
如果原文很长,优先按小节改写,并保留标题层级。
交付前检查:
chinese-tech-plain-writing。doc-visualizer。doc-visualizer 做阅读页面。npx claudepluginhub billbai/bba --plugin bbaGuides creation, editing, and verification of skills for AI coding agents using test-driven development with subagent scenarios. Use when authoring or debugging skills.