概述
# 标准模板
产品文档中心提供如下标准文档,文档格式参考对应模板,文档在左侧导航栏以下述文档的序号顺序保持一致。
| 序号 | 文档 | 文档模板 |
|---|---|---|
| 00 | 发版说明 必选 | 发版说明 |
| 01 | 产品简介 必选 | 产品简介 |
| 02 | 产品白皮书 必选 | 产品白皮书 |
| 03 | 功能清单 必选 | 功能清单 |
| 04 | 快速入门 必选 | 快速入门 |
| 05 | 安装手册 必选 | 安装手册 |
| 06 | 用户手册 必选 | 用户手册 |
| 07 | 开发手册 | 开发手册 |
| 08 | API文档 | API文档 |
| 09 | 插件说明 | 插件说明 |
| 10 | 适配说明 必选 | 适配说明 |
| 11 | 性能说明 | 性能说明 |
| 12 | 性能调优手册 | 性能调优手册 |
| 13 | 数据迁移手册 | 数据迁移手册 |
| 14 | 常见问题 必选 | 常见问题 |
| 15 | 版本发布历史 必选 | 版本发布历史 |
提示
非 必选文档由各产品团队结合产品情况进行提供。
根据需要可以额外补充其他文档,不限于上述文档清单。
# 内容约定
# 格式
文档采用Markdown格式进行编写。
# 图像
文档中所使用的图像文件,必须是符合版权要求,严禁使用来源不明或第三方非授权图像文件。
文档中所使用的图像文件,须保存在文档同级目录下的
assets目录中。
# 代码
文档中使用的代码,截止使用截图,须用 代码块 格式包围,例如:
public class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello World");
}
}
1
2
3
4
5
2
3
4
5
# 公式
文档中使用的公式,截止使用截图,须用 公式块 格式包围,例如 $$ f(x)=w^Tx+b $$ 更多关于markdown中编辑公式的教程请参考 markdown中公式编辑教程 - 简书 (jianshu.com) (opens new window)
# 文档编写帮助
请参考文档中心帮助
编辑页面 (opens new window)
发版说明→