SuperAPI AI 工具集

docs

写作与研究

查看项目

更新于 10-16 06:05

技能介绍

这是一套用于编写、编辑和组织文档的 AI 技能规范,属于 tanstack/ai 项目。它的目标是写出真实读者愿意阅读的文档:简短、平实,围绕用户想要完成的具体任务展开。

用途定位

文档随代码一起交付。该技能应在三个时机运行,而不只是在被要求时:有人明确要写文档;在仓库中规划功能或改动时列出新增和需更新的文档;在实现收尾时于宣布完成前写好或更新文档。作者认为,改变行为却不更新文档的工作算不上完成。

两阶段工作流

先规划故事,再写作。

第一阶段:列出读者是谁、他们想要什么,以及需要多少页面。为每位读者写一条用户故事(“作为 X,我想要 Y,以便 Z”),一段旅程对应一个页面。页面拆分由此得出。

第二阶段:动笔写作。

整体流程为:找到文档 → 阅读邻近页面 → 第一阶段(读者+页面)→ 人物关卡 → 语气关卡 → 加载 simple-english 与 i-have-adhd → 第二阶段写作。

人物关卡:展示读者列表后默认停下,等待用户确认、删除或新增读者。除非本会话已确认该列表、用户表示使用默认值或只是极小的文案修订,否则不得继续。技能特别指出,“读者很明显”“用户既然要求写文档就不想被问”等都不是跳过关卡的理由。

语气关卡:位于第一、二阶段之间,写作任何页面前运行。先一行说明从邻近页面推断出的语气,再让用户选择沿用、更随意、更正式或自定义。同样默认停下,除非满足跳过条件。

前置技能

最终页面需要 simple-english 和 i-have-adhd 两个前置技能。它们只作用于文档页面,不作用于规划对话。写作页面内容前立即加载两者。若文件缺失,须停下告知用户,不得在缺失情况下继续写页面。

分工为:本技能负责页面面向谁、页面拆分、先问题后方案、展示而非讲述、不泄露历史、禁用字符及邻近结构;simple-english 负责句子(务实模式);i-have-adhd 负责页面形态(先给出下一步行动、编号步骤、列表最多 5 项、无开场白、结尾有可见成果)。从本技能加载 i-have-adhd 时仅应用于页面,不切换整个会话模式。

先找到文档

在写任何内容前先定位文档位置。依次检查 docs/、documentation/、content/docs/、site/、website/docs/。若找不到,询问用户,不得猜测或擅自建文件夹。打开新内容附近的 2 到 3 个现有页面,阅读其文案、结构、frontmatter 字段与组件,记录其语气作为语气关卡的候选。注意站点已使用的组件(steps、tabs、callouts 等),复用它们来讲故事,绝不发明站点没有的组件。

安装命令使用站点的包管理器标签,不要把 npm / pnpm / yarn 堆在一个代码块里。文中给出了各框架的核心聊天安装包示例(react、vue、solid、svelte、preact、angular、octane、vanilla),并说明 mode="install"、mode="dev-install"、mode="local-install"、mode="custom" 的含义,以及每个框架各列一行、不随框架变化的包在各行重复等规则。该标签不适用于环境文件、沙箱 setup 数组,或混合安装与其他命令的代码块。

“匹配邻近页面”涵盖文案、结构、frontmatter 与组件,但不替代语气关卡,也不授权复制邻近页面的坏习惯。本技能明确的所有规则仍然适用,现有页面违规不应成为再犯的理由;若认为整套文档需要修正,应作为单独的清理事项向用户提出。

第二阶段:像人一样写作

在人物关卡通过、语气关卡通过、并加载两个技能前,不得写页面内容。清晰易读高于一切。保持可消化,避免大段文字;句子遵循 simple-english 务实模式;markdown 保持轻量;优先使用普通 ASCII 与键盘字符,不用华丽符号;使用第二人称、动作先行,避免“本指南将探讨……”式开场。

先问题后方案

每个页面先用读者自己的话写出他们遇到的问题,再给 API。让读者几秒内判断自己是否找对了页面。指南的顺序是:问题、一句话解法、然后才是怎么做(步骤、代码片段、API)。问题保持在几句话内,不要写成背景长文。

展示而非讲述

能用一句话加一个代码块说明的,不用四段话解释。每个代码示例复制后应能运行,不留需要想象的缺口。

该列表就列表

一旦句子覆盖多个条目、选项、步骤,就改成分列表。无序列表用于顺序无关的集合;有序步骤用于按序执行;表格用于每项有相同两三个属性可比较时;段落只用于单一想法。列表项保持简短平行,超过两项句子的列表项宜独立成小节。列表超过 5 项要拆分,把“现在做”放前面,其余移到后续页面或“稍后”。

指南的页面形态

问题、解法、步骤、完成。开头写读者的问题和最终成果,用一句话说明功能如何解决,随后是边做边测的步骤,让代码来解释,达到目标即结束,不要用含糊的“后续步骤”堆砌收尾。参考页(props、类型、签名)保持可快速扫描,并链接回展示其用法的指南。

为读者写作,不为历史写作

文档描述现在存在的东西。读者没见过旧设计、旧名称、草稿 PR 或被替换的 API。不要通过对比未发布的版本来解释当前 API。文中给出正反示例,例如不写“我们把 useAssistant 改名为 usePlugin”,而直接描述 usePlugin。

限制与未提供信息

以上为资料中描述的全部内容。具体价格、收费模式、平台支持范围、效果数据等,资料中暂未提供。