用途:规范仓库内散文类文本的写法,包括 docstring、注释、limitations/、README、提交信息、PR 描述和警告。读者是寻找事实的工程师,写作目标是直接给出事实:说明发生什么、何时发生、代价是什么,而非说服或铺垫结论。
主要能力:列出常见的大模型写作痕迹并给出改写方式,包括用意义代替机制、开场铺垫、"not just X but Y"式揭示、用形容词代替事实、复述签名、自我总结、无关的来历故事。还专门讨论"流畅感"问题:为节奏而造的句子、制造悬念的时序、告诉读者如何感受、三段式与反转、可引用的收尾、为对称而对称。
用词与隐喻:反对把软件写成在空间中移动的物体或有意图的人,给出替换表,如 lands 改为 merged/released、spin up 改为 start、wire up 改为 pass/connect、surface 改为 raise/return/report/log、under the hood 改为 internally 等;同时保留 heap、stack、pointer、hot path 等术语。
结构与格式:首行说清事物是什么;推理用散文,真正的列表才用项目符号;一句一个想法,超过约 30 词拆分;注释和字段文档 1 行、最多 3 行,函数和结构体 docstring 不超过 5 行;警告先写命令或条件,再写后果与隐蔽路径,最后写安全替代,并置于被警告内容之前。Markdown 硬换行 120 字符,尽量一句一行,列表续行缩进到标记内容列,代码块、表格、标题不重排。
用词与标点:utilize/leverage 改为 use,in order to 改为 to,serves as 改为 is,prior to 改为 before;一个概念只用一个术语;名词堆叠最多三个词;用主动语态和简单时态;避免或极少使用破折号;可用缩写;面向用户文档用第二人称,指令用祈使句;不确定才用模糊限定词。
检查草稿:这句话能否原样出现在别的项目文档里;每个论断能否指向对应代码;删掉第一句是否损失信息;朗读时是否像会议演讲;去掉节奏后还剩几个事实;审阅者能否从签名之外学到东西。
使用方式:按上述规则写作与编辑;重排现有文件可运行 python3 .claude/skills/writing-style/rewrap_md.py <file>...,该命令原地重写,跳过围栏、表格、标题和 frontmatter。
限制:资料未提供该技能的安装方式、适用平台、收费情况或效果数据。