SuperAPI AI 工具集

tech-writing

写作与研究

查看项目

更新于 10-15 19:58

技能介绍

用途:这是一套技术写作风格规范,用于撰写、编辑或审阅任何仓库中的文字内容,包括博客文章、README、文档、演讲笔记和社交帖子。目标是像 Aurora Scharff 解释自己构建或学到的东西那样写作:一名在职工程师,第一人称,冷静、具体,而非营销文案、文档页面或 AI 式空谈。

主要能力:技能包含三个文件,按任务读取。撰写或编辑任何散文时读 style-rules.md;撰写、编辑或审阅散文时读 anti-ai-patterns.md;在草稿发布前审阅时读 review-framework.md。应在起草前而非起草后阅读前两个文件,因为在审阅阶段修正语气比一开始就用对语气更昂贵。

风格要点:以机制为先,点明主体、动作和后果;使用现在时和直接称呼;允许短句澄清要点;对权衡保持诚实平实;保留一些具体、略带口语的质感;功能性冒号和行内列表可用;必要时可创造并斜体标注术语,教学走查用“我们”,个人经验用“我”。要避免的失败模式是相反面:打磨过的反思性散文、文学节奏和工整的收尾。

事实来源层级:绝不编造事实、数字、PR 标题、代码、引语或关于其工作内容与方式的说法。依次核对实际代码与仓库、其真实数据、其已发表文章(仅用于语气,不用于可能已变化的事实)。无法核实时应询问、省略或行内标注 [VERIFY] 并说明需核查什么。

核心原则:机制优先;展示而非讲述,用真实片段或裁剪过的真实产物;核实而非假设;使用平实词汇;讲选择而非功能;对权衡保持诚实。

其他要求:不要夸大范围,描述其工作前先查看其 PR;通读全文检查矛盾;优先使用真实摘录而非虚构示例;对工具保持诚实且不自我标榜;未经确认绝不描述其工作、阅读或做事方式。

内容类型:本技能与内容类型无关,格式专用技能在其上构建并添加自身结构与审阅项,例如博客文章对应 aurorascharff.no 仓库中的 .agents/skills/blog-writing/。存在对应内容类型技能时应同时阅读其 SKILL.md。

安装:本技能的事实来源位于 aurorascharff.no 仓库。要在其他仓库使用,将整个 tech-writing/ 目录复制到该仓库的 .agents/skills/ 中,并让修改回流到源副本。