开发者文件

开发者文档

以文件驱动的文档首页,服务产品、固件、App、云端与运营团队。

Realtek Connect+ 设备、云端、App 与运营团队的平台界面

Realtek Connect+ 保持第一版文档首页精简,同时让更深入的文档章节继续沿用既有 catalog 与服务器端渲染。

文档架构预览

这个来源文件驱动的页面让团队能迭代文档首页内容,而不需要在同一个版本中迁移功能页或详细文档页。

入口結構

选择符合你工作流的文件軌道。

在深入实作前先定位平台范圍。

产品總览

Realtek Connect+ 评估所需的平台架構、能力地圖与商业封装指引。

  • 平台架構敘事
  • 跨配网、OTA、App、洞察与云端的能力地圖
  • 面向产品团队的商业评估框架
开启章節

以一个交付計畫組織韧体、云端与 App 工作流。

开发

整理此工作流的目标、交付内容与团队权責,协助 Realtek Connect+ 评估与导入。

  • 工作流范圍
  • 跨团队責任
  • 导入检查点
开启章節

透过結構化整合介面开放云端能力。

API

REST、MQTT over TLS、webhook 与服务合约文件入口。

  • 装置、使用者、OTA 与 analytics 的 REST resource 类别
  • MQTT over TLS 装置讯息与状态更新
  • 营运事件交付的 webhook pattern
开启章節

记录打造連网产品体验所需的开发者介面。

SDK

行動 SDK、韧体 SDK、可重用 client 元件,以及用于产品验证的参考范例。

  • iOS 与 Android 行動整合路徑
  • 韧体端服务与身分建構区塊
  • Android、iOS、WebApp、Linux 模拟器与 PRO2 装置参考范例
开启章節

釐清装置軟体堆疊必須提供的能力。

韧体

整理此工作流的目标、交付内容与团队权責,协助 Realtek Connect+ 评估与导入。

  • 工作流范圍
  • 跨团队責任
  • 导入检查点
开启章節

用可重複的命令列流程支援开发者与营运者。

CLI

整理此工作流的目标、交付内容与团队权責,协助 Realtek Connect+ 评估与导入。

  • 工作流范圍
  • 跨团队責任
  • 导入检查点
开启章節

记录评估与商用部署背后的生产執行設定。

部署

生产部署設定、持久化 SQLite 储存、反向代理 TLS、健康检查、备份/还原与回滾注意事項。

  • 具备模板与靜态資产的容器或 VM 部署設定
  • 用于联络与分析事件的持久化 SQLite volume
  • TLS 終止、快取标頭与探針由反向代理或託管邊緣負責
  • 生产发布的备份、还原与回滾检查点
开启章節

追蹤韧体、云端、App 与营运介面的产品演进。

版本資讯

版本化變更紀录、升級说明、相容性声明与发布溝通模式。

  • 逐版本产品變更摘要
  • 升級注意事項与相容性提醒
  • 面向客戶的发布溝通結構
开启章節

文件管理首页内容

文档首页标题、摘要、叙事与 metadata 现在由 content/docs/zh-CN/docs.yaml 载入。

支持多语言内容来源

英文、繁体中文与简体中文文件并列,无需调整 template 就能更新。

运行期重新载入

运营人员可通过受保护的 admin refresh endpoint 重新载入内存内容缓存。

为什么重要

对齐产品上市前各团队期待的文件介面。

共同平台敘事

让产品、业务与工程利害关系人,在深入实作前先理解生命週期范圍。

依工作流分層

分开韧体、API、行動 SDK、部署与版本議題,让各团队直達自己的实作面。

靜态優先版本

維持 Go template 与伺服器端渲染架構相容,同时保留后續深入内容空間。