SuperAPI AI 工具集

material-component-doc

写作与研究

查看项目

更新于 10-15 20:09

技能介绍

用途:为 FlowGram 物料库组件撰写文档,提供从源码定位到中英翻译的流程指导与自动化支持。

主要能力:按固定流程完成组件文档撰写,包括源码定位、需求收集、功能分析、Story 创建、文档撰写与质量检查;提供 Story 组件规范(kebab-case 文件命名、PascalCase+Story 导出、React.lazy 懒加载、类型标注、英文代码注释);提供物料文档模板与章节结构(Import、标题简介、案例演示、API 参考、源码导读);支持中文文档确认后翻译为英文。

使用方式:文档目录为 apps/docs/src/en 与 apps/docs/src/zh,Story 组件位于 apps/docs/components/form-materials/components,物料源码位于 packages/materials/form-materials/src/components,模板为 ./templates/material.mdx。启动文档站点命令:rush dev:docs。查看修改:git diff、git diff --cached。

适用场景:FlowGram 物料库组件文档编写、Story 创建、中英文档翻译与质量检查。

限制:翻译须在用户明确要求且中文文档经审核确认后执行;代码、命令、路径保持原样;内部链接 /zh/ 改为 /en/;图片存于 apps/docs/src/public/materials,引用路径为 /materials/{物料名称}.png。具体收费、价格、平台等信息暂未提供。