更多支持

API 文档除了基本的功能构建,一些额外功能可以方便用户的使用,让用户更加依赖公司的产品。

丰富的多媒体

对于无法用文字和图片描述的文档,应该使用相应多媒体来生动的体现,能让开发者更加直观的理解。

material-transition
material-transition

开发者平台

为开发者提供的资源,让开发者可以在这里找到最相关的公司产品和技术资源。

版本控制

需要为 API 文档提供版本回退,文档历史版本等等功能,让用户能找到相应的需要版本。

tensorflow-versions
tensorflow-versions

多平台文档

API 文档存在多个平台使用的时候,需要考虑的问题就要多一些,主要包括这些。

语法高亮

不同语法的代码高亮

快速切换其他平台

当开发者属于全栈开发时,能给开发者一个快速切换其他平台文档的功能。

文档的统一性

不同平台的文档应该 UI 设计和操作流程统一,减少开发者学习成本和适应时间。

国际化

  • 扩展到国际市场
  • 更高的用户转换率

SEO 优化

迎合搜索引擎的规则以及让用户能通过其他渠道搜索到相应的文档。

网站性能优化

  • 提升用户访问体验
  • 优化服务器负载
  • 考虑其他弱网等环境

results matching ""

    No results matching ""