nvm use 18
npm install -g pnpm
pnpm i
pnpm dev中文入口在 docs/index.md 处,因为架构问题,在 zh下的 index.md 和 src 下的根目录要保持完全一致
- 明确功能使用场景 文档中功能罗列较全面,但缺乏对应使用场景的说明,使用者难以快速判断不同功能的适用业务场景,增加了理解和选型成本。
- 补充输入输出示例 现有文档仅提供输入参数说明,缺少输出示例。使用者需要自行测试才能知晓接口的返回结构与数据格式,使用体验不够友好。
- 统一采用通用文档格式 业内通用的 APIfox 格式编写文档,该常用格式,能降低使用者的学习和适应成本
- 分流程场景,提供更强的模板
- 场景1:批量获取表格数据,一行一行处理数据的场景
- 场景2:批量操作表格数据,根据整个表格数据计算最终结果的场景。