| name | clear-technical-writing |
| description | 写作中文数学与机器学习技术文章。默认产出连续、有主线的文章,而不是教材目录、知识清单或参考手册;用一个具体问题和一个主例带读者完成关键推理,详细解释认知瓶颈,并在承诺完成后及时停止。适用于概念解释、数学推导、论文解读、研究史与实用指南。 |
clear-technical-writing
目标是重建一次理解真正发生的过程。文章可以承载很深的数学,但不能把“相关内容很多”误当成“解释得好”。默认读者有推理能力、没有当前专题的知识库存,也没有时间阅读一章百科全书。
先卡住文章形态
除非用户明确要求教材章节、完整综述或知识手册,否则遵守以下默认约束:
- 写连续文章,不写分层提纲。标题数量必须来自真实的认知转折,不能预先凑数;如果每个术语、性质和应用都各占一节,说明范围已经失控。
- 不给章节编号,不在每节之间放水平分隔线。标题应表示推理正在发生什么,而不是把知识分类。标题明显多于真正的认知转折时,重新审查范围,不要用合并标题掩盖主题膨胀。
- 正文以段落为主。只有内容真正并列、改写成句子反而更难读时才使用列表;不要把一句接一句的解释自动排成 bullet point。
- 选定 一个贯穿全文的主例。其他例子只有承担不同的认知任务时才保留,不能仅用于展示覆盖面。
- 明确全文的核心证明或认知转折,让详细推理围绕它组织。其他路线只有揭示不同来源或改变结论意义时才展开。
- 不追求预设字数。篇幅可以因核心推导困难而增长;不能为了显得完整、系统或有分量而增加相邻概念。
这些是默认值,不是机械排版模板。题目很小就更短;用户明确要求长篇或完整教程时才放宽。
动笔前私下写六行
下面六行只用于规划,不得原样输出:
首要问题:本文只回答什么?
开场疑问:什么具体事实让这个问题值得问?
主例:哪一个熟悉对象能承载全文?
关键转折:读者的理解在哪一步改变?
结束线:读者能够解释或推出什么时,本文就完成?
明确不讲:列出最容易诱使本文跑题的相邻主题,直到边界清楚。
如果“首要问题”“关键转折”或“结束线”不能各用一句话说清楚,先缩小题目。题目只是范围,不是主线。
对于“介绍某个概念”这类宽题,主动选择一个更窄的问题,例如“这个概念为什么有必要”“它解决了哪个旧定义的不足”“哪个定理使它不只是换一种说法”。不要自动写成定义、性质、例子、推广、应用、相关概念的全景巡礼。
假设数学成熟度,不假设专题知识
默认读者是“会推演的专题外行”:能读公式、追踪对象类型,掌握与文章直接相关的基础代数、微积分、线性代数、概率或基本证明语言;能够自行补普通消元、链式法则和一两步机械验证。
但不能默认读者知道:目标专题的术语和惯例、某个定义为什么自然、两个熟悉对象之间的新连接、论文脉络,以及不服务于主线的高级形式主义。
写前把知识分成四层:
- **稳定底座:**可以直接使用的低层工具;
- **可唤醒知识:**学过但需要一句话或一个公式恢复的事实;
- **本文新知:**必须完整建立的概念和连接;
- **边界外理论:**删除、外链或另文处理的旁支。
是否解释不取决于概念看起来高级还是基础,而取决于它是否承载主线。链式法则若只是机械运算,可以略;一个人人听过的定义若其精确约定决定后文,就应重新固定。
特别前沿的数学
用户点名一个前沿领域或概念,只说明学习目标,不说明已经掌握该领域的标准语言。目标概念在同一专题内的直接前置,也不能静默当作已知。
但“不能假设前置”不等于“补一遍整个领域”。只建立主线马上会用到的最小前置,并尽量在主例中建立。如果解释一个前置会迫使文章再引入三个新术语,优先换成更具体的说法,或把前置拆成另一篇文章。
每个最终获准进入文章的新概念,首次出现时交代它是什么类型的对象、允许什么操作、为何此刻需要,并立即在主例中使用。先限制概念数量,再解释概念;不要对已经不该进入文章的旁支做耐心科普。
让问题牵引文章
一个常用但不固定的理解顺序是:先让读者遇到具体疑问;用最小设置把疑问写准确;从主例中发现旧描述不够用;引入新视角;详细完成最关键的推导;回到开场问题说明它已怎样被解决;然后停止。
这是认知顺序,不是七个章节标题。相邻动作通常应合在同一节中。章节数量来自真实转折,不能把每一步机械拆成一节。
解释性文章通常不要先给完成态定义或摘要。先呈现一个确实需要新概念才能解决的具体困难、矛盾或缺口,让形式化把疑问变准,而不是替换疑问本身。若用户明确要求速查或直接定义,则服从任务,不强造悬念。
结尾必须回扣开头。若开头提出两个疑问,正文应明确回答这两个疑问,而不是用“应用广泛、未来可期”收尾。相关但尚未讲的理论可以在最后一句点名,不能就地展开。
用一个主例把路走通
主例不是装饰,而是文章的实验台。定义、记号、核心推导和意义解释都尽量回到它。不要每讲一条性质就换一个新领域展示“普适性”。
第二个例子只有在完成下列任务之一时才保留:
- 检验新视角确实能迁移,而不是主例的偶然技巧;
- 通过反向箭头或改变约束,显露主例看不出的结构;
- 直接回答开头留下的第二个疑问。
如果同一层级的一串相关构造、方法或应用依次登场,文章通常已经从解释滑向目录。选一个最能承载主线的对象讲透;其余只有在改变核心结论时才展开,否则删除或至多一句指出属于后续。
按认知瓶颈分配篇幅
最详细的地方应是读者理解真正改变的地方:旧图景跨向新图景的桥、结论无法从定义直接看出的证明、容易把方向或对象类型搞错的约定,以及能区分当前解释与其他解释的关键证据。
下列内容应明显更短:熟悉定义、泛泛动机、相关工作巡礼、实现样板、完整 API、排障清单、重复同一点的例子,以及不改变核心理解的边界情况。
主题重要不等于篇幅要长。一个小代数步骤若是认知瓶颈,可以写得细;一个完整子领域若只是背景,可以一句带过。文章的长度应由核心证明的难度决定,而不是由作者知道多少决定。
多种证明或解释并非一律删除。第二条路线只有在揭示不同来源、改变结果的意义或让结论迁移到新场景时才保留;仅仅重复结论则删除。
让公式承担叙事动作
每个展示公式都要完成一件事:把谜题写准确、消掉未知量、揭示等价关系、产生下一个自然问题,或建立所声称的后果。
公式之前先提出它要回答的问题;密集推导之后,用普通技术语言说明刚才改变了什么。不要用大量公式为文章制造严肃感,也不要在公式后只做同义复述。
面对困难推导,先从最干净的情形推出可复用关系;只有代数真的变化时才分情况。不要以所有病态情况开场。限定应在使用相关假设的那一步就地出现,不要在结尾集中列成防守清单。
当代数已经回答“为什么”时,不要为了显得更深,再追加一套不改变理解和用法的几何、信息论或优化语言。
把作者判断写进解释
可以明确判断什么优雅、可疑、居于中心或只是过渡方案,但要给理由。严格区分已证明恒等式、由恒等式提示的解释、实验观察和个人偏好。
不要为了中立而把所有可能解释并列成优缺点清单。选出文章真正建立的解释,在相关位置说明一次边界即可。真实的不确定、失败尝试或历史分歧若能显露问题形状,可以保留;不要编造发现故事。
论文解读应使用论文真正报告的结果,说明各实验支持机制中的哪一步。假想实验不能替代结果解读。历史背景只有在改变贡献判断时才保留。
按任务类型微调
**概念解释:**从一个具体困惑和一个主例出发,重点回答“为什么需要这个概念”和“哪个结果使定义站得住”。避免同类概念巡礼。
**数学推导:**让一个基础方程生长出全文。先处理最干净情形,再推广;把篇幅留给真正困难的消元、变换或证明。
**研究史或综述:**按支配性思想或数学形式的变化组织,只纳入改变概念轨迹的工作,不按年份逐篇列举。
**论文解读:**从旧方案的具体不足开始,重建问题为什么迫使作者做出非默认选择;按实验检验解释中的哪一环组织结果。
**实用指南:**假设读者已有可用 baseline,只写迁移时真正改变的约定、缩放、超参数和适用参数,不重复通用训练基础设施。
成稿后做强制截断
先不要润色,逐节删除。每一节必须至少满足一项:建立跨越关键转折所需的新推论;检验该推论;避免一个会改变结论的明确误解。三者皆否,整节删除。
尤其检查以下失败信号:
- 一个单一概念被拆成大量二级标题,每节只负责知识分类而不推动推理;
- 标题编号从 1 一直排下去,文章看起来像课程讲义;
- 连续列举多个同类例子或相关构造,却没有产生新的推理作用;
- 正文依赖大量 bullet point,而不是因果相连的段落;
- 开头两三百字已经给出完整解释,后面仍继续扩张;
- 为展示“统一性”或“深度”而引入主线并不需要的上层理论、新记号或新术语;
- 到达结束线后又追加应用、推广、FAQ 或第二套理论;
- 小想法被额外记号和宏大框架撑成一章。
若出现这些信号,默认删,不默认辩护。
最后私下确认:读者能否用一句话说出文章的新理解?最详细处是否正是最难的推理?所有前置是否都在主线中被实际使用?主例是否贯穿全文?结尾是否回答了开头?承诺完成后是否立即停止?