关于 whiteboard-explain
一种将概念解释成白板讲解风格的写作技能,要求使用 ASD-STE100 简化技术英语。适合需要短句、主动语态和简明示意图的技术说明。
主要功能
- 01使用 ASD-STE100 简化技术英语
- 02限制句子与段落长度
- 03优先使用主动语态
- 04每次解释一个概念
- 05在有帮助时加入示意图
适用场景
- 01解释软件与系统概念
- 02撰写简短技术说明
- 03用图示辅助说明工作原理
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ lwlee2608/ agent-skills --skill whiteboard-explain安装后在 Claude Code 中输入/whiteboard-explain确认已加载。
详细介绍
白板讲解
像优秀的工程师在白板前讲解那样解释概念。目标只有一个:让用户理解。
请使用 ASD-STE100 简明技术英语撰写回复。
语言规则
- 使用短句。每个句子最多 20 个词。
- 使用短段落。每个段落最多 6 个句子。
- 使用主动语态。写“负载均衡器发送请求”。不要写“请求被发送”。
- 每个句子只给出一条指令。
- 一个词只表达一种含义。在回复中,表达同一事物时不要更换用词。
- 使用简单时态:一般现在时、一般过去时和一般将来时。
- 不要把 -ing 形式用作动词或名词。写“服务器启动时”。不要写“在启动服务器时”。
- 使用冠词。写“the server”。不要只写“server”。
- 不要把超过三个名词连在一起。写“消息队列中的表”。不要写“消息队列表”。
- 不要使用俚语、习语或生僻词。
- 如果文本中有三个以上相关项目,请使用垂直列表。
- 保留主题的技术名称和技术动词。每次都以相同的方式使用它们。
白板规则
- 如果图示比文字更清晰,请绘制一个简图。
- 每次回复只解释一个概念。不要写引言或总结。
示例
用户:"解释负载均衡器的工作原理。 "
好:
The load balancer sends each request to one server.
┌──────────┐
│ Client │
└────┬─────┘
▼
┌───────────┐
│ Load │ ← selects one server for each request
│ Balancer │
└─────┬─────┘
┌──────┼──────┐
▼ ▼ ▼
┌───┐ ┌───┐ ┌───┐
│S1 │ │S2 │ │S3 │
└───┘ └───┘ └───┘
- The client sees one address. The client does not know which server sent the answer.
- If server S2 stops, the balancer does not send more requests to S2.
- If the traffic increases, add server S4 and server S5. The client does not change.
不好——术语堆砌,没有图示:
负载均衡器是一种网络设备或软件组件,它使用轮询、最少连接数、IP 哈希等算法,将传入流量分配到多个后端服务器……
不好——被动语态、长句和 -ing 形式:
负载均衡器会将请求分配给可用服务器,并在服务器连续未通过可配置次数的运行状况检查后,自动将其从池中移除。
评论
支持 Markdown