SuperAPI AI 工具集

writing-docs

写作与研究

查看项目

更新于 10-16 07:58

技能介绍

用途:本指南用于撰写和编辑 Remotion 官方文档,适用于新增文档页、编辑 packages/docs 下的 MDX 文件,以及编写文档正文。

主要能力与规范:文档位于 packages/docs/docs 目录并以 .mdx 文件保存;新增页面需创建 .mdx 文件、将其加入 packages/docs/sidebars.ts 并运行 bun render-cards.ts 生成社交预览卡。属于某包的页面需在 frontmatter 加 crumb: '@remotion/package-name' 以显示面包屑。规定一个 API 一页,不合并多个 API;仅记录公开 API,不引用内部实现。正文中 API 名用反引号,函数与 Hook 名带括号如 useVideoConfig(),组件带尖括号如 <Player>;所有字段用标题而非列表,顶层属性用 ###,嵌套属性用 ####。

版本与兼容:API、功能或参数自某版本新增时加 <AvailableFrom>;API 页面应在 ## See also 前加入带 <CompatibilityTable> 的 ## Compatibility 节。可选参数在标题加 ?,CLI 标志除外,并在描述中说明默认值;同时可选且新增时可组合使用。

语言与代码:保持简洁,用 you 称呼读者,避免情绪化用语、"simply""just" 及归咎用户的表述,术语不加粗,链接到术语页。代码围栏标注语言,优先用 twoslash 做类型检查,可用 // ---cut--- 隐藏设置代码,示例代码块要加 title。

特殊组件:<Step> 每行一个并在 </Step> 后加空格,需要换行时显式使用 <br />;实验性功能用 <ExperimentalBadge>;交互演示用 <Demo> 且需在 packages/docs/components/demos/index.tsx 实现;<AvailableFrom> 与 <CompatibilityTable> 无需导入。

适用场景:编写、审阅或精简 Remotion 文档时使用,可扫描缺失的版本标识、未格式化的 API 名、缺少的兼容表及损坏的 <Step> 格式。限制:资料未说明收费、价格、平台与其他未提及事项,暂未提供。