Talk about documentations (2022-10-20)

Topics

• 文档 site 的布局与样式

• 图形库的名字

  1. 中文 “仓库图形库”
  2. 英文 “WarehouseGUI” ？

• 讨论一下文档的作用，从两个视角

  1. 作者
  2. 阅读者

• idea：从文档出发驱动实现

• 图形库的构建打包：umd + d

• 拿两个写好的文档一起具体讨论下：

  • 排版
  • 能否读懂
  • 能否通过文档了解到作者的设计
  • 有什么好的意见/建议

• 内容的两个部分：

  1. api - 注释
  2. overview

会议记录