SuperAPI AI 工具集

technical-writing

写作与研究

查看项目

更新于 10-17 00:38

技能介绍

技术写作技能用于为 eve 编写准确、面向任务的文档。该技能把开发者和 AI 智能体都视为读者,目标是让每个章节都易于扫描、检索和直接执行,而不依赖未明确写出的上下文。

用途 该技能用于撰写、编辑、审阅或审计 eve 仓库中面向用户的文档。适用场景包括:docs/ 目录下的改动、与 eve API 或 CLI 行为绑定的文档、基于 Slack 或支持反馈开展的文档工作,以及让 eve 文档更清晰、更自然、减少 AI 生成痕迹的请求。

使用方式 该技能要求先选择工作流:新建页面或整体重写时,阅读 references/writing-workflow.md;对现有页面做局部或结构性修改时,阅读 references/editing-workflow.md;任何改动定稿前,阅读 references/review-framework.md;处理格式与术语时,阅读 references/style-rules.md;处理措辞、语气或 AI 痕迹问题时,阅读 references/prose-quality.md;当内容类型不明确或发生变化时,阅读 references/content-types.md 来确定页面结构。

主要能力 该技能规定了明确的来源层级用于核实事实,而不是依赖训练数据。优先级依次为:packages/eve 中的当前源码、公开类型和测试;当前 CLI 帮助与 setup 实现;docs/ 下已有页面;已合并的拉取请求、变更日志和发布说明;research/ 下的研究计划(仅代表提议意图,不代表已交付行为);Slack 线索或 issue 等支持证据。支持证据只用于识别读者问题,不用于确立产品行为。命令、标志、API 名称、默认值、限制和示例都要对照当前仓库核实;纯文档改动还要对照最新公开发布版本,避免文档宣布仅存在于分支上的行为。如果文档与产品代码在同一改动中,需要在评审时说明这种依赖关系。无法核实的说法应省略或上报缺失的负责人或来源,完成的文档改动中不得保留 [VERIFY] 标记。

eve 约定 该技能要求遵循 eve 的写作约定:eve 一律小写,标题和句首在可行时也小写;使用精确的公开名称,如 defineAgent、eve dev、eve add channel/slack;区分根 agent、内置 agent 工具、声明的子 agent 和远程 agent,因为它们有不同的继承与执行语义;区分 eve 连接与 Vercel Connect、面向模型的 Workflow 工具与作者编写的 Vercel Workflows、持久会话状态与沙箱文件系统或附件存储;准确命名诊断界面,Vercel 运行时日志、Agent Runs、OpenTelemetry、eve logs、eve traces 不可互换;把 docs/** 视为已发布文档,导航变化时更新 docs/meta.json;.md 文件保持框架无关,只在 .mdx 文件中使用 MDX 组件,且仅当邻近页面已确立该惯例时;尽量保留已发布路由和标题锚点,移动页面时更新作者链接并为旧的 HTML 与 Markdown URL 添加永久重定向;优先使用 TypeScript 示例,包含 import 和语言标注,并对照当前导出核实示例;只展示受支持的命令和标志,记录前查阅 CLI 帮助或命令实现;链接相关页面时使用描述性文字,并把关键事实写在本地,因为被检索的章节可能脱离链接单独阅读;不留孤立页面,每个页面至少需要一个来自相关 hub 或概览页正文的描述性入站链接,仅靠 meta.json 侧边栏条目或路由表单元格不够,新增页面时应在同一改动中从拥有该主题的页面添加入站链接,并保证从 getting-started 出发沿正文链接可到达每个页面;不要把提议中的行为写成已交付,当不支持边界影响用户任务时要直接描述。

写作要求 每个页面和章节要先给出答案或结果;用 you 称呼读者,步骤使用祈使动词;优先使用主动语态、现在时、具体名词和一致术语;保留作者支持的语义、细微差别和不确定性,做最小有效修改,不动本来写得好的文字;一个页面聚焦一个主要任务,如果某页面已拥有该任务,就在该页面添加章节;先写正常路径,再写替代方案和失败模式;当观察到的失败集中在某个工作流附近时补充疑难排查,使用症状、已核实原因和具体下一步检查;章节自包含,关键陈述重复完整名词而不是依赖模糊代词;只在仓库或权威平台来源支持时使用具体限制和行为。

常见失败 该技能明确禁止:发明标志、注册表条目、连接器、变通方法或平台保证;把一个产品需求变成一个新页面,而应先判断缺口属于文档、产品还是两者;当聚焦章节或交叉链接即可解决时重复宽泛指南;仅为符合个人偏好而重写清晰文字;为让文字更像人类而编造示例、观点、反应或具体细节;使用推广语言、反问、填充语,或声称某任务容易、简单、快速;除非描述 Vercel 或 eve 团队有意的行动,否则不使用 we。

完成改动 收尾步骤为:完整重读每个改动页面;对照来源核实每个新的技术说法;搜索矛盾陈述和受影响的交叉链接;确认新增或移动的页面有来自相关页面的正文入站链接,避免孤立页面;运行评审流程;当措辞有实质变化时对照散文质量参考检查改动的文字;准备推送时运行 pnpm docs:check,除非用户要求更早验证。

限制 该技能面向 eve 仓库及其文档体系,未提供其他产品或仓库的适用说明。技能内容中没有提及收费、价格、平台支持范围或效果保证。