// Start of Selection
概述示例
开始使用
[本文档仅为示例,使用 A/B/C/M/N 作为占位符]
快速入门
[教程的高级索引]
场景 A 的快速入门
用一句话描述场景。确保回答以下问题:谁应该阅读此文档?解决了什么问题?预期的输出是什么?
- 前提条件:列出用户需要准备的背景知识和环境。
- 步骤 1:执行某些操作以达到某个输出。
- 步骤 2:执行某些操作以达到某个输出。
- 步骤 3:执行某些操作以达到最终输出。
下一步:
- 学习相关教程 M
- 学习相关教程 N
示例或展示:
- 重要博客链接 A
- 典型示例链接 B
- 展示 C
场景 B 的快速入门
与场景 A 相同,如果您的产品有多个角色或包含多个核心工作流。
介绍
[解释的高级索引]
什么是 A?
用一句话定义产品。确保用户能在一分钟内理解您试图解决的问题。
列出基本概念:
- 概念 A
- 概念 B
- 概念 C
它是如何工作的?
简要描述产品的高层架构。然后添加一些图示并链接一些核心设计规范。
- 系统上下文图
- 组件图
- 核心流程图
列出一些核心功能的技术设计链接:
- 功能 A 的设计规范
- 功能 B 的设计规范
A 如何帮助您
用 1-3 点描述产品的核心价值。以下是示例:
- 使用核心功能 A 自动化某些操作
- 使用核心功能 B 降低某些成本
- 使用核心功能 C 解决可扩展性问题
还列出一些数字以说服潜在用户,例如:
- 性能比其他解决方案高 11 倍
- 在某些流程中节省 70% 的时间
列出比较:
- 与竞争对手 A 比较
- 与竞争对手 B 比较
何时选择?
目标和用户故事。
何时不选择?
非目标和不适用的场景。
使用指南
[操作指南的高级索引,假设此产品是一个无服务器平台,这里是一些示例内容,使用“操作指南”风格或简单动词短语]
开始开发
[用户核心流程第一阶段的使用指南]
- 如何创建 Git 仓库?
- 如何设置开发环境?
- 如何添加和配置数据库?
- 如何调试和测试我的服务?
发布到生产环境
[用户核心流程第二阶段的使用指南]
- 如何配置发布设置?
- 如何发布我的服务?
- 如何引入自己的云?
- 如何监控我的服务?
参考资料
- API 文档链接
- TypeScript SDK 链接
- Golang SDK 链接
- Python SDK 链接
- Rust SDK 链接
首页的其他内容
[这些内容应发布在首页]
常见问题
- 5-10 个常见问题及其答案,绝不超过 15 条
资源
产品与服务相关:
- 状态与事件页面
- 帮助中心
- 基准测试结果
- 博客
- 展示
- 更新日志
- 预约演示
安全与合规相关:
- 安全白皮书和 SBOM 信息
- SOC2/HIPPA/GDPR 等证书
- 服务级别协议 (SLA)
- 服务条款、隐私政策、EULA、开源许可证等
公司与团队相关:
- 社交链接,如 Twitter、Discord、Github、LinkedIn 等
- 团队和公司介绍链接
- 职业和招聘页面