SuperAPI AI 工具集

docs-writer-reference

通用与其它

查看项目

更新于 10-16 01:14

技能介绍

用途:这是 React 官方文档仓库(reactjs/react.dev)中用于编写 src/content/reference/ 参考页的写作规范,帮助作者按统一结构撰写 API 参考文档。

主要能力:提供页面类型决策树,按对象判断使用哪种模板——Hook 或独立函数用 Type A,React 组件用 Type B,编译器配置项用 Type C,指令(如 'use server')用 Type D,ESLint 规则用 Type E,多 API 索引页用 Type F。每类模板给出 MDX 骨架,包括标题、Intro、Reference、Parameters/Props、Returns、Caveats、Usage、Troubleshooting 等章节及对应锚点 ID。

写作约定:语气为权威、精确、中立的参考文风;开头用一句话说明用途;参数区分必填与 optional;返回值按单值、数组、对象、Promise 等分别给出写法;Caveats 覆盖 Hook 调用位置、稳定标识、Strict Mode 等常见限制;Troubleshooting 用第一人称问题式标题。还规定组件放置顺序(RSC 在 Intro 前、Deprecated 位置、Canary 内联)与提示框不得连续堆叠。

使用方式:按决策树选定模板后套用骨架撰写;组件选择、语气、Sandpack 代码注释等细节需调用 /docs-components、/docs-voice、/docs-sandpack 等配套技能。

限制:资料未提供安装命令、收费信息或具体平台支持范围;部分内容(如代码注释约定、组件模式)仅以引用其他技能的方式给出,未在本页展开。