V5 文档调整方案

[pearmini]

文档调整

V5 在去掉 next 标签的时候，需要对文档进行一系列调整，这里记录一下调整的思路。

存在问题

• 整体结构：内容太分散，或者说教程和文档的定位不清晰，导致用户不知道看哪个地方。
• API： Spec 和 API 该如何共存。

思路

• 教程：一篇一篇独立的文章，分别介绍一些用法。（基础、动画、服务端渲染等等）
• 文档：体系化的讲述完整的 Spec，各个可视化组件以及每个部分都有什么。
• API：罗列 Chart API，并且向文档引导。

Tab 修改如下：

• 文档
• 选项：各个组件的配置
• API：chart 的 API

文档

期望用户是直接看文档能知道 G2 完整的用法和特性，教程只是快速的辅助工具。

• 介绍
  • 什么是 G2：介绍一下 G2 的使用方式和背景等。
  • 为什么选择 G2：介绍 G2 和 G2 5.0 的新特性。
  • API 风格：讲解 Spec 和 API 的异同，以及后面文档的讲解方式。
  • 开始使用：普通的使用方式，以及在不同的框架中使用。
• 图表选项（总体讲解 Spec）
  • Chart
  • Marks
  • Data
  • Scales
  • Transforms
  • Labels
  • Tooltip
  • Components
  • Coordinate
  • Animations
  • Compositions
  • Interactions
  • Themes
• 教程
  • 绘制条形图（基础概念）
  • 探索企鹅数据（数据探索）
  • 可视化叙事（动画）
  • 图表联动（交互）
  • 封装图表库
  • ...

TODO

• 调整总体结构（一个 PR）
• 补全文档
  • 交互 Demo（一个 PR）
  • 梳理和补全文档（多个 PR）
• 增加教程
• 梳理 API

参考

• Plot
• Vega/Lite
• Vega/Lite-API