读者为什么要学

说明写满「高效、灵活、强大」,读者却不知道下一步做什么。先把第一句改成一个具体问题:保存失败时,为什么界面仍显示成功?不要编造亲身经历来增加说服力。

给概念一个落点

先说明错误会造成什么,再解释原因、给出方法,最后用一个小场景检验。前后变化能让读者看到方法解决了什么,一个概念先配一个例子。

按问题、原因、方法、例子讲解 / Teach through a concrete problem, its cause, a method and an example.按问题、原因、方法、例子讲解 / Teach through a concrete problem, its cause, a method and an example.
按问题、原因、方法、例子讲解。

Sometimes, all it takes to teach something is to find the perfect example

本站译意:有时教会一个概念,只需找到恰当的例子。

— Matt Pocock

让句子承担工作

清楚动词比空泛形容词更有用。「验证失败后保留输入」能指向行为,「体验全面升级」则不能。短句、留白和对照服务理解,不是模仿作者口吻的配方。

写法读者能做什么
使用健壮的验证机制无法判断该改哪里
验证失败时显示字段名并保留输入能实现并检查一个行为

英式口语、粗话与特定标点都不是教学质量的必要条件。先删掉不改变读者行动的句子,再检查是否缺少关键限制。

改写后,把例子的输入和预期结果分开检查:缺少输入,读者无法判断情境;缺少预期,就无法验证答案。保留让判断成立的信息,再删装饰性的词。

看懂之后,关掉答案

根据 Matt Pocock 的 skills 仓库改编,MIT;来源文件:skills/productivity/teach/SKILL.md。

01

独立提取

合上说明,自己解释或完成一道题。

02

间隔重试

过一段时间再答,记录遗忘的位置。

03

交错练习

混入相近问题,练习选择方法。

练到能解决新问题由 Archify 生成的工作流图。练到能解决新问题小课独立提取间隔交错练习能解决新问题?✓ 完成× 看完觉得流畅是来源与改编独立编排;依据 skills /teach 结构(MIT)。改编登记与许可见本站版权说明。能解决新问题? → 独立提取否小课 → × 看完觉得流畅不算完成
通过提取与练习检验迁移能力。

先教一个小概念,再做需要判断的练习。把完成标准写成「能处理一个没见过的输入」,不要用「刚读完很顺畅」替代。完整许可附后(见页末),另见版权页。

教学也要核验

AI 生成的解释可能包含事实错误。为关键结论保留可信来源,请人检查例子与答案。归档样本中的点赞、书签相关性,不能证明某种写法必然有效。

练习:改掉三个形容词

动手练习

把说明变成小课

  • 原稿:我们的导入功能强大、智能、易用。
  • 任务:写出读者问题、一个具体方法和一个可判定结果。
  • 变式:输入从缺姓名改成重复编号,重新设计反馈。
参考思路

示例:导入表有一行缺姓名,怎样定位?返回行号与字段名;修正后可重新导入。重复编号需指出冲突行,不能沿用缺字段答案。

完成标准:另一位读者只靠你的说明就能预测正确反馈;变式题的答案也能解释原因。接着用反馈与署名改进讲解。

速查

01

开头

一个真实困惑或明确目标。

02

展开

问题、原因、方法、具体例子。

03

完成

独立做新题,核对行为与来源。

来源

skills MIT 许可声明

本页改编的结构来自 mattpocock/skills,MIT 许可,Copyright (c) 2026 Matt Pocock。完整许可附后,与原仓库 LICENSE一字不差。

完整许可:mattpocock/skills

MIT License

Copyright (c) 2026 Matt Pocock

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

非官方、非商业的学习整理,与 Matt Pocock 无隶属或背书关系。所引作品版权归原作者;MIT 复用内容另附版权与许可声明。