玩转平台丨平台文档中心升级通知
1466 浏览2024年12月26日作者:抖音开放平台团队

关注专题不迷路,进入“玩转平台”专题首页,点击“关注”即可


开发者您好,

基于之前收到的关于文档的反馈,经过内部讨论后,在 11 月集中调整了开发者平台各应用的目录结构,希望帮助开发者提升查找效率和使用体验。

调整范围

抖音开放平台-开发者平台的各类应用:

  • 小程序
  • 移动/网站应用
  • 小游戏
  • 直播小玩法
  • 直播互动工具
  • 生活服务商家应用

调整说明

各应用统一一级目录结构

应用下的一级目录按使用场景组织。

有些应用因为业务属性,没有相关目录或会有额外的目录。


目录内容

小程序

移动/网站应用

小游戏

直播小玩法

直播互动工具

生活服务商家应用

快速入门

提供应用、能力的整体介绍,使用路径等,帮助开发者快速入门。

✅

✅

✅

✅

✅

✅

能力

各种能力的定义、使用场景、接入及开发接口信息。

✅

✅

-

✅

✅

✅

设计

设计原则、规范及资源。

✅

-

-

✅

✅

-

开发

各种开发教程、所有组件/API 的参考信息,及开发工具。

✅

✅

✅

✅

✅

✅

运营

应用运营/经营所需的指引、标准、数据、规范及服务协议。

✅

✅

✅

✅

-

-

重点梳理了小程序的二级目录

由于时间和资源有限,所以这次重点梳理了小程序的二级目录。

一级目录

二级目录/文档

定义和范围

快速入门

文档指引


开发者使用路径中各阶段、场景所需的、指导开发者怎么做的最小文档/视频集合。

小程序概述

应用的定义、价值、使用场景、开发者角色、基本概念等。

能力概述

小程序所有能力的定义、分级、及相关接入教程或接口。

小程序开发指南

系统性介绍小程序从开发到下线全部流程

能力


解决方案

文档站会逐步下线,后续请访问平台首页中的解决方案。

流量入口

抖音内外可以打开小程序的入口场景,和对应入口生效所需的权限功能介绍。

通用能力

搭建小程序所必要的能力,影响小程序最小功能实现。

经营能力

帮助小程序变现和提升转化效果的能力。

商业变现

小程序内获取商业结果的能力,支付、广告和线索。

投放推广

通过商业化平台推广小程序获取 DAU 和 GMV 结果的能力。

行业开放

行业特色能力,后续用于汇总经过小程序行业插件开放的能力。

开发

教程

指导开发者如何开发应用的操作类文档。包含入门、基础(框架)、能力、行业维度等。

框架

框架、组件、API 相关的参考类文档。


组件

JS API

服务端 OpenAPI

开发工具

开发者使用的开发工具的介绍及使用指南。如 IDE、抖音云。

更新日志

前端基础库及 IDE 的版本更新日志。

设计

设计原则与规范

小程序的通用设计原则、视觉规范及组件资源。

行业设计规范

各种行业需要额外遵守的设计规范。

经营

小程序创建

各类规范和服务协议等文档,计划组建独立的规则中心,所以该目录调整为经营。

后续只包含应用经营过程中各环节/场景相关的指南、介绍和参考。


服务类目

主营类目

版本审核

运营管理

经营数据

行业规范

应用经营过程中各环节/场景相关的参考。


能力规范

服务协议

文档排版优化

和目录结构一起,此次文档站还优化了部分展示布局和排版,希望帮助开发者提升阅读效率和体验。

  • 优化左侧目录视觉体验,增加层次感和辨识度,并支持收起,帮助开发者浏览更多内容。
  • OpenAPI 文档双列布局,开发者可以同时查看参数信息及代码示例。

期望

我们无法收集到所有开发者的反馈和需求,调整难免有不周之处。所以,期望把你的意见和建议反馈给我们。

反馈渠道

调研问卷

有帮助/无帮助

在线纠错,反馈你发现的问题,有机会获得积分奖励

示意图

/

最后一次编辑于 2026 年 02 月 27 日
共 3 条评论

相关公告

专题推荐

热门文章

热门问答