開發者文件

開發者文件

以檔案驅動的文件首頁,服務產品、韌體、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-TW/docs.yaml 載入。

支援多語內容來源

英文、繁體中文與簡體中文檔案並列,無需調整 template 就能更新。

執行期重新載入

營運人員可透過受保護的 admin refresh endpoint 重新載入記憶體內容快取。

為什麼重要

對齊產品上市前各團隊期待的文件介面。

共同平台敘事

讓產品、業務與工程利害關係人,在深入實作前先理解生命週期範圍。

依工作流分層

分開韌體、API、行動 SDK、部署與版本議題,讓各團隊直達自己的實作面。

靜態優先版本

維持 Go template 與伺服器端渲染架構相容,同時保留後續深入內容空間。