SuperAPI AI 工具集

plate-docs

写作与研究

查看项目

更新于 10-24 23:36

技能介绍

用途

Plate 文档技能负责维护 Plate 的公开文档体验,包括写作风格、页面构成、示例覆盖、安装配置、API 教学、MDX 使用和导航结构。它适用于在 content/docs 目录下进行任何编辑之前,例如修复一行现有建议、创建中文对照页或嵌入演示,也适用于编写或审计 Plate 的公开文档。

主要能力

  • 遵循项目内部写作风格(shadcn 密度和页面构成),并优先于 pstack:technical-writing 的通用展示默认值。
  • 以 Plate 源码作为 API 行为、导入、需求和示例的权威依据。
  • 保持代码、命令、标识符、frontmatter 和链接目标不变,除非变更明确覆盖它们;保持数字、版本和名称与其来源一致。
  • 保持义务词(must、may、never)、不确定性和有意义的范围限制与来源强度一致,不将可能性变成保证。
  • 代码片段遵循仓库格式化器的两空格缩进,而非 technical-writing 的制表符规则。
  • 处理请求的页面、功能或文档审计;审计报告基于来源的缺口,编辑保持在请求范围内。
  • 一般散文(计划、报告、README、PR 描述)直接交给 pstack:technical-writing。
  • 对于微小文案编辑,读取文本并解析更改的链接,无需加载无关的文档机制;英文页面编辑仍会重建文档注册表(在验证表的注册表行适用时)。
  • 读取目标页面、其最近的有用同级页面以及拥有每个更改声明的源码。从当前源码和公共导出开始。
  • 文档描述当前 API;未解决的 API 设计属于 Best API,在教学之前不涉及。
  • 内部风格:shadcn。使用 shadcn 控制密度和页面构成;Plate 源码拥有 API 行为、导入、需求和示例。
  • 快速开始:frontmatter 提供标题和描述;仅在澄清任务、所有者或易混淆的同级页面时添加简短引导语。
  • 将第一个有用的预览或工作路径放在更深入解释之前;当 kit/CLI 路径是实际支持的默认方式时优先推荐,手动或无头替代方案放在其后。
  • 保持组件页面集中:安装、用法、可见示例和紧凑 API 参考可以服务于一个读者目标;每个部分只做一件事。
  • 展示导入和最小的真实工作示例;代码需要上下文时添加,明显用法不需要仪式性的引导句。
  • 优先使用真实预览和一行有用说明,而非描述视觉变体的段落;使用 MDX 组件进行真实结构或选择,而非装饰。
  • 保持参考紧凑:精确名称、类型、选项和简短注意事项;在可比页面间保留已建立的标题和锚点。
  • 简要解释非显而易见的选择;运行时概念可能需要比 UI 组件更多上下文,密度不能隐藏所有权或生命周期行为。
  • 仅记录最新状态。绝不写变更日志式语言("has been removed"、"new feature"、"previously"、"now supports")、迁移说明或"what changed";写得好像不存在先前版本。
  • 对于重大的风格或页面形状决策,比较最近的 Plate 同级页面与 ../shadcn/apps/v4/content/docs/ 中的相关页面;组件示例包括 components/base/button.mdx、chart.mdx 和 sidebar.mdx;安装和注册表页面涵盖各自的形状。读取适用页面,而非整个语料库;此比较不需要上游同步。
  • 覆盖功能的实际使用:根据读者需求选择示例;识别页面的重要读者任务、声明和可能的误解,并为每个在示例、精确参考部分或链接指南中提供明确位置;选择每个示例以帮助读者完成或理解不同的事情,保持足够小以理解且足够完整以使用,并命名其前提条件;当现有示例已服务于读者时重用或链接它;在示例处标记模拟服务或本地快照,并将不支持或未验证的行为陈述为限制而非发明。审计报告缺失覆盖;实现保持在请求范围内。
  • 对于功能和组件页面:以命名功能的聚焦示例开头;在设置中使用其 kit 和所需依赖;完整应用 EditorKit 属于以其组成为目的的示例;在 Plate UI 的教学/安装规则下保留显式功能配置。
  • 为重要任务和实质不同的状态在示例、片段、参考部分或链接指南中提供明确位置;仅在影响此功能时考虑创建和编辑、边界和历史、持久化和恢复以及渲染或访问模式;不要求每个类别、每个 API 方法的演示或固定数量的预览。
  • 让每个额外示例教授不同的任务、行为或有用的视觉变体;重用注册的演示,并将组合链接到其所属页面,而不是在同级页面中复制相同的混合功能预览。
  • 将集成要求放在需要它们的示例旁边;在设置中展示最低前提条件;将详细所有权和生命周期解释放在工作示例之后或链接的概念指南中。
  • 保持示例声明在其证明范围内:内存保存/重载演示本地往返;标记模拟故障;只读编辑器设置不建立应用授权;修订示例时保留已建立的夹具和有意义的交互。
  • 对于覆盖审计,考虑重要的范围内任务和状态及其位置或缺口;在需要时使用现有报告或计划;不要创建第二个清单或将仅措辞编辑扩展为审计。通过下面现有的证明所有者验证更改的示例。
  • 选择需要的机制:更改的契约读取新页面、重大重写或文档缺口/拓扑决策时读取页面形状,仅选择匹配的通道;MDX 组件、导航、安装要求或发布路线时读取 MDX 和路由;公共模式、身份、迁移、装饰或渲染器示例时读取公共 API 示例;插件设置、kit/手动路径、格式映射、事件或 API 示例时读取插件文档。
  • 对于缺口审查,在添加页面前比较最近的概念指南、公共参考和功能页面;将精确签名放在其参考中,设置放在功能页面中,跨包解释放在概念指南中;合并重复概念并链接到一个所有者;仅在添加、移动、合并或删除路由或更改导航时读取 content/docs/meta.json。
  • 验证更改的声明:仅散文或链接时,读取编辑的文本并解析更改的链接,保留代码和元数据;MDX 结构或示例时,运行 pnpm --filter www build:source,并根据源码验证符号、导入和围栏内容;文档源码一致性或生成文档时,运行 pnpm --filter www check:docs;在分支的注册表生成规则允许本地构建时,对英文 content/docs 页面或根 meta.json 的编辑,在最终散文通过后运行一次 pnpm --filter www build:registry,然后运行 pnpm --filter www build:registry --check;当 check:docs 或 www 类型检查链的较早链接在 HEAD 处为红色时,分别运行每个后续链接;新/移动路由或导航时,解析更改的元数据并请求确切路由,当分页器/侧边栏更改时检查它们;预览或可见组件行为时,解析真实演示并在该确切路由/状态上使用 verify;注册表源码时,参考 Plate UI 和分支的注册表生成规则。
  • 在最终散文通过后运行一次适用的检查;新的源码更改或失败可能需要再次通过;MDX 解析不能证明路由、运行时 API 行为或浏览器输入;报告确切的证明限制。

使用方式

该技能通过读取目标页面、同级页面和源码头文件来工作,根据请求的更改类型选择必要的机制(页面形状、MDX 和路由、公共 API 示例或插件文档),并在编辑后执行相应的验证命令。对于仅散文或链接的更改,读取编辑文本并解析链接即可;对于 MDX 结构或示例更改,需要运行构建命令并验证符号、导入和围栏内容;对于注册表相关更改,需要运行注册表构建和检查命令。

适用场景

  • 编写或审计 Plate 公开文档页面。
  • 更新组件文档,包括安装、用法、示例和 API 参考。
  • 调整 MDX 结构、导航或路由。
  • 验证文档更改的源码一致性和示例行为。
  • 修复文档中的小错误或链接。

限制

  • 该技能依赖仓库工具链(如 pnpm 过滤命令)和特定的文档风格(shadcn),不适用于通用散文写作;通用散文应使用 pstack:technical-writing。
  • 文档只描述最新状态,不写变更日志式语言或迁移说明。
  • 示例声明必须在其证明范围内,不支持的或未验证的行为应标记为限制,而非发明。
  • 审计报告缺失覆盖,但实现保持在请求范围内。
  • MDX 解析不能证明路由、运行时 API 行为或浏览器输入,需要报告确切的证明限制。
  • 具体的收费、价格、平台支持等信息暂未提供。