前端组件库文档:AI辅助生成标准化开发指南
提示词描述:
面向前端开发者的技术文档自动化解决方案,通过结构化输入生成符合工业标准的组件说明。内置代码高亮与类型校验机制,确保技术表述零歧义,支持Swagger/OpenAPI规范导出。
提示语关键词:
前端开发工具,组件库文档生成,React组件说明,TypeScript文档模板,API文档自动化,开源项目维护
提示词内容:
【使用场景】
适用于UI组件库维护、开发团队技术文档编写及开源项目说明文档构建,需保持技术表述严谨性与示例代码规范性。
【操作步骤】
1. 定义组件元数据:填写{组件名称}、{依赖框架}、{核心API}字段
2. 配置文档维度:勾选必要模块(安装说明/Props表格/事件回调/代码示例)
3. 注入技术规范:要求遵循W3C语义化标准,添加TypeScript类型定义标注
【效果示例】
输入:DataGrid|React18|columns/dataSource/onRowSelect
输出:「## DataGrid 数据表格组件
### 安装
```bash
npm install @ui/datagrid --save
```
### Props说明
| 参数 | 类型 | 默认值 | 说明 |
|------|------|--------|------|
| columns | ColumnType[] | - | 列配置数组 |
### 类型定义
```typescript
interface ColumnType {
key: string;
title: string;
render?: (value: any) => React.ReactNode;
}
```」
【进阶技巧】
接入ESLint规则校验生成内容,自动标记未覆盖的边界条件说明