Documentation Surface
文档不是孤立站点,而是产品前台的一部分。
当客户、合作方或开发者第一次接触 ZhenRent,他们需要同时理解平台是什么、如何接入、价格怎么组织、争议如何处理,以及哪些能力已经进入生产闭环。这个页面的目标,就是把这些入口对齐。
详细技术文档仍然放在专用文档站,但公开站必须给出清晰的入口顺序和上下文,否则“有文档”和“文档好用”之间还差一步。
Read This First
公开站里的文档页负责导航和上下文收口,详细内容仍托管在专用文档站。
如果你来自销售、合作或客户预审流程,建议先看白皮书和定价,再进入 API 文档。
如果你是开发者,最快路径是从快速开始进入,再补读 API 参考和示例代码。
公开文档前台与 `/docs`、`/redoc`、`/openapi.json` 接口端点必须显式区分,不能混成同一个入口。
Doc Entry Points
四个最常用的入口
Suggested Flow
建议阅读顺序
01
先看平台模型
先理解真人执行层、支付闭环、申诉治理和状态机,再做接入设计。
02
跑通快速开始
进入统一控制面创建 Scoped API Key,按最小任务样例完成一次发单与状态回流。
03
对接 API 与 Webhook
将你的业务系统接到任务创建、支付查询和回调处理链路。
04
结合公开规则上线
把定价、白皮书和申诉规则一起纳入客户预审与生产说明。
API Endpoint Split
公开文档前台和 API 端点必须分开理解
`/guide` 负责什么
负责把公开文档、白皮书、下载和接入顺序收成统一前台入口。
`/docs` / `/redoc` / `/openapi.json` 负责什么
它们是 API 端点文档,不是项目治理首页,也不承接公开业务叙事。
正式配置在哪里做
Scoped Key、模板、Webhook 和组织级配置仍进入统一控制面,而不是留在文档前台里完成。
docs, pricing, trust and onboarding
想直接进入技术接入,或者先看平台全貌。
可以直接打开专用文档站,也可以继续看白皮书、定价和申诉规则,把公开前台和技术接入一起对齐。