SuperAPI AI 工具集

docs-writer-learn

通用与其它

查看项目

更新于 10-16 01:14

技能介绍

用途:在编写或编辑 react.dev 仓库 src/content/learn/ 下的 Learn 页面时使用,提供 Learn 页面的结构变体与语气规范。

主要能力:定义四种页面结构——标准 Learn 页(含 YouWillLearn、正文、Recap、Challenges)、章节介绍页(使用 isChapter={true} 与 LearnMore,不含 Recap/Challenges)、教程页(含 Intro、Note、目录、渐进式代码,不含 YouWillLearn/Recap/Challenges)、参考型 Learn 页(含 YouWillLearn 与 Further learning)。规定标题 ID 采用 {/kebab-case/} 格式及生成规则,并给出教学写法:问题优先(先展示错误代码再解释再修复)、渐进式复杂度、编号步骤、交互式邀请、决策性问题。同时规定组件放置顺序、交叉引用(概念链到 /learn,API 细节链到 /reference)以及 Do/Don't 清单。

使用方式:语气、大小写与术语调用 /docs-voice;组件结构与语法调用 /docs-components;Sandpack 文件结构与代码风格调用 /docs-sandpack。

限制:Learn 页面通常不使用 --- 分隔线;不得连续放置 Pitfall 或 Note;避免使用 simple、easy、just 及时间估计;不得引用尚未介绍的概念。具体收费、平台与效果信息暂未提供。