ChatGPT Docusaurus 文档技能:为新 API 匹配参考、教程和版本
EnglishChatGPT 安装步骤
- 打开固定提交的 .claude/skills/documentation/SKILL.md,核对原文的输入和输出。
- 在 ChatGPT 打开「插件 → 技能 → 创建 → 使用编辑器创建」。
- 按下面的工作流程填写技能规则。提供包的公共导出、类型、版本和 Docusaurus 栏目材料。
- 保存技能,在新对话输入本页的虚构示例并核对结果。
中文摘要
用导出清单、类型和文档目录确定新功能应写在哪里。按版本、签名、基本用法、进阶和 FAQ 组织可追溯的参考草稿。
SKILL.md 中文导读
可复现示例
虚构测试运行器新增公开选项 `quiet`,只在当前版可用,旧版没有。输入含类型、默认 false 和已有命令页。请列文档改动。工作步骤
- 从公共导出映射到文档栏目。
- 按签名、默认值、示例和边界写参考。
- 核对导航、版本和教程交叉链接。
验收方法
把选项放到当前版运行器参考,列默认值、最小用例和旧版适用性说明。若教程需用该选项,给对应入口并引用参考。
GitHub 原文 · 更新日期
适用环境
需要启用了技能创建的 ChatGPT 工作区。这里使用基于 GitHub 原文编写的文本改编。
常见问题
仓库中所有内部函数都要写 API 参考吗?
先核对包的公共导出和支持契约。内部实现可出现在架构文档,公开参考聚焦用户能够调用的接口。