用途
docs-creator 是 udecode/plate 项目中用于创建或更新 Plate 文档的技能,也是 Plate 文档风格与工作流的唯一事实来源。其核心目标可概括为:让文档既能教会人类读者,又能被智能体清晰解析。
该技能针对 Plate 文档常见的失败模式进行约束:把文档写成参考堆砌而非可运行路径、所有权边界模糊、缺少“为什么”、用感觉代替代码。
主要能力
- 定义共享文档法则:语气与语调、信息顺序、lane 选择、所有权清晰度、反低质规则、面向智能体的可发现性。
- 规定插件页面的章节顺序、kit/手动结构、组件/API 校验以及插件专属示例。
- 提供文档目标模板(docs goal template),用于非平凡的文档工作。
- 定义文档 doctrine 与路由规则;docs goal 模板负责收尾契约,包括 lane 分类、有来源支撑的声明、所有权映射、链接/演示检查、内容构建和反低质审计。
- 提供 gap review 与页面拓扑决策方法,将缺口分类为:缺失心智模型、缺失精确选项/签名/返回值、缺失单一能力的设置路径、同一概念被拆分、页面仅重复现有参考、行为真实但难以发现等,并给出对应修复方式。
- 规定 shadcn 风格层:密集、结构化、组件驱动,包括 frontmatter、引导段落、单一职责章节、MDX 组件使用、包管理器命令、带标题的代码围栏、示例先预览后解释、紧凑的 API 参考等。
- 规定语气:直接、shadcn 式密集、渐进式、先“为什么”后“是什么”、引导而非仅展示、渐进构建、庆祝完成、真实代码、分层强化、突出真实陷阱。
- 规定结构规则:开头三句以内、所有权声明、快速路径优先、参考最后、智能体可发现的标题、页面长度控制。
- 规定导航与路由:新增/移动/合并/删除页面属于路由变更,需更新 meta.json、categoryGroups、items,添加来自最近拥有页面的链接,验证路由本身,不留孤儿页面。
- 规定发布文档:/docs/releases 是文档拓扑而非 changeset 策略,保留最近两个大版本组,旧版本移至专门页面。
- 规定代码示例规则:仅使用仓库支撑的示例、真实导入、无占位注释、行号与高亮、标题、内联代码卫生。
- 规定链接、演示与预览、智能体可发现性、反低质规则。
使用方式
该技能以规则文件形式存在,源文件为 .agents/rules/docs-creator.mdc,生成的技能副本为 .agents/skills/docs-creator/SKILL.md。修改规则后需运行 pnpm install 重新生成技能副本,并在交付前验证生成的技能包含预期规则文本。若生成输出漂移,应修复源文件并重新生成,不要手工修补生成的技能文本。
对于非平凡文档工作,使用文档目标模板:
node .agents/skills/autogoal/scripts/create-goal-scratchpad.mjs \
--template docs \
--title "<short docs title>"
当文档只是另一主导任务下的支撑面时,不要将主模板切换为 docs,而是将 docs pack 添加到所属计划:
node .agents/skills/autogoal/scripts/create-goal-scratchpad.mjs \
--template task \
--with docs \
--title "<short task title>"
对于同时改动文档的重量级架构或提案工作,使用 major 主模板加 packs:
node .agents/skills/autogoal/scripts/create-goal-scratchpad.mjs \
--template major-task \
--with docs \
--title "<short major task title>"
不要将其用于微小文案编辑、拼写修复或单行链接修复,除非调用方明确要求目标支撑的文档任务。
写作前应只阅读真正能为页面提供依据的内容:目标文档、同一 lane 中最近的兄弟文档、所记录行为或 API 的源代码,以及最强基线文档。当任务涉及文档风格、shadcn 对齐、registry 组件、安装页面或 MDX 组件用法时,还应阅读本地 shadcn 参考语料。
适用场景
- 创建或重写 Plate 文档页面。
- 更改公共行为文档。
- 涉及插件/API/spec/序列化文档。
- 移动路由、更改示例。
- 可能留下过时导入、链接、预览、所有权声明或 API 声明的工作。
- 文档缺口审查与页面拓扑决策。
- 文档导航与路由变更。
- 发布文档维护。
限制
- 不适用于微小文案编辑、拼写修复或单行链接修复,除非调用方明确要求。
- 不得手工修补生成的技能文本,必须修改源文件并重新生成。
- 不得伪造演示名称、不得编造 API、不得使用占位注释、不得声称运行时未实现的模型或行为。
- 若未添加 .cn.mdx 页面,中文文档可能回退到英文,应记录为注意事项而非假装已翻译。
- 页面超过约 300 行需添加锚点列表,超过约 600 行考虑拆分并先询问。
- 源代码中的沉默是缺口,而非同意。
关于该技能的收费、价格、平台支持等具体信息,资料中暂未提供。