SuperAPI AI 工具集

technical-writer

写作与研究

查看项目

更新于 10-22 01:30

技能介绍

Technical Writer 是一个面向开发者文档写作的技能,来源为 vercel-labs/deepsec。它的核心用途是撰写、审阅和编辑 SDK、库、框架的开发者文档,包括 ai-sdk.dev、chat-sdk.dev 等文档站点。目标是写出能帮助开发者理解 SDK、选择 API、实现功能并诊断失败的文档,同时应用目标文档站点的术语、结构和组件约定;对 Vercel 项目使用 Vercel 的编辑语气。

主要能力

该技能覆盖写作、审阅和编辑三类任务。写作时先确定读者任务:读者是谁、已掌握什么、读完后需要理解、决定或做什么,以及文档类型、目标站点、相关既有页面、产品版本、运行时、权限等影响答案的条件。审阅时区分事实错误与编辑偏好,指出具体问题及其对读者的影响,并在有用时提供替换文本。编辑时先识别问题再改动,做能解决根本问题的最小修改,保留已经有效的措辞、示例、解释和限定条件。

该技能还包含编辑标准、技术核实和内容模式三类指导:每个写作或编辑任务都要读编辑标准;当内容涉及产品声明、操作步骤、配置或代码时,要读技术核实;在规划或重构文档页面时,要读内容模式。

使用方式

在编辑仓库前,先查看其说明、邻近页面、导航配置和文档工具,匹配现有的 Markdown 或 MDX 格式、frontmatter 字段、代码块元数据和受支持的组件。新页面应放在开发者预期的导航位置,链接到前置条件和权威 API 参考,而不是复制其内容。使用站点自身的路由和锚点约定,重命名标题或移动页面后检查链接。

内容需要基于证据。默认针对当前仓库源码核实技术声明和代码示例:确定相关包和目标版本,检查公开导出、类型、实现和针对性测试。可变更的产品事实应使用官方文档、维护中的仓库、变更日志和规范核实;对 Vercel 主题使用 ai-sdk.dev、chat-sdk.dev、nextjs.org、vercel.com 等官方文档及项目维护仓库。不得为了完成草稿而编造基准、配置项、命令结果、URL 或功能;证据不足时应收窄或删除声明,或在编辑说明中标注未解决点。

写作风格上,以答案或结果开头,尽早引入准确的产品或 API 术语,使用美式英语、句首大写标题和牛津逗号,用“you”称呼读者,步骤用祈使动词,优先主动语态和现在时。新写散文中不使用破折号。操作步骤使用编号列表,每步有明确目标、足够细节和可观察结果;UI 标签加粗并精确匹配。行内代码用于文件路径、命令、标识符、环境变量和字面值;围栏代码块标注语言,包含必要导入和配置,不放置密钥。

适用场景

适用于为 SDK、库、框架撰写或修订文档页面,审阅既有文档,重构文档结构,核实技术声明与代码示例,以及编辑仓库中的文档文件并同步导航和交叉引用。也适用于需要遵循特定文档站点术语、组件和导航约定的写作任务。

限制

该技能要求不改变代码标识符、引用的错误信息、UI 标签或官方名称来满足行文规则。不得编造功能、收费、价格、平台、效果或使用步骤。当仓库缺少相关实现时,应使用依赖项的维护源码或官方文档,并说明剩余的核实缺口。本地实现不能证明功能已对客户可用,提案不能证明行为已发布。临时工作笔记可能消失,最终文档必须放在请求的目标位置,未解决的重要问题需在交接中说明。该技能的具体安装命令、收费方式和平台支持信息暂未提供。