在线文档与版本历史

本文介绍 iOS-JL_Health 仓库的文档体系（README、docs/ 目录、在线文档中心 doc.zh-jieli.com 及仓库内 Sphinx 文档产物）与 SDK 版本历史记录，帮助开发者快速定位所需资料并了解各版本的能力演进。

Purpose and Scope

本页面向开发者与集成方，系统梳理 iOS-JL_Health 的资料获取路径与版本演进脉络，包括：

• 仓库内外的在线文档入口（README、docs/ 目录、在线文档中心、问题反馈渠道）；
• 文档产物的组织方式（Sphinx docs/document/ 目录结构与章节划分）；
• README「八、版本历史」中记录的 SDK 版本迭代信息，以及各版本的能力变化解读；
• 开发者从「读文档 → 集成 → 查版本 → 反馈」的完整资料使用流程。

以下主题不在本页范围内，请查阅对应目录页：

• SDK 的功能模块与集成步骤，见仓库 README「一、概述」「三、快速开始」及在线文档中心；
• 各业务库的 API 细节，见在线文档中心 api_desc 章节与 libs/ 下各 XCFramework 的接口声明；
• OTA、表盘、音频编解码等具体功能的实现，见对应功能开发说明（如 杰理OTA升级(iOS)开发说明.url）。

Overview

iOS-JL_Health 是珠海市杰理科技股份有限公司为杰理蓝牙穿戴类产品提供的 iOS 功能集成 SDK，仓库同时承载「示例代码 + SDK 库 + 开发文档」三部分内容。其中文档与版本信息是整个 SDK 的使用入口：

• README.md / README_EN.md 提供中英双语总览，涵盖概述、运行环境、快速开始、工程结构、配置说明、调试技巧、社区与支持、版本历史、许可证九大章节；
• docs/ 目录存放发布记录 PDF 与三个在线文档快捷方式（.url 文件），是文档中心的本地入口；
• docs/document/ 是 Sphinx 生成的文档构建产物（doctrees 与 HTML），章节覆盖开发（API 描述、功能描述、导入）、框架、其他（联系我们、调试、SDK 常见问题、在线文档、版本）与资源；
• 在线文档中心 https://doc.zh-jieli.com/ 是文档的权威线上版本，README 中「SDK 接入文档」直接指向其 iOS health 主页。

版本历史以「版本表」形式维护在 README 中，最新版本为 V1.14.0(Beta)（2026/03/03），同时提供 Jieli_Health_SDK_iOS_Releases.pdf 作为完整发布记录。

文档体系架构

仓库内文档与在线文档中心共同构成一套「仓库内自包含 + 线上权威发布」的双层资料体系，其结构关系如下：

flowchart TD
    subgraph sg_Repo["仓库内文档资源"]
        README["README.md / README_EN.md"]
        DOCS["docs/ 目录"]
        PDF["Jieli_Health_SDK_iOS_Releases.pdf"]
        URL_FILES["三个 .url 在线文档快捷方式"]
        SPHINX["docs/document/ Sphinx 产物"]
    end

    subgraph sg_Online["在线渠道"]
        CENTER["文档中心 doc.zh-jieli.com"]
        ISSUES["GitHub Issues 问题反馈"]
        SITE["官方网站 zh-jieli.com"]
    end

    README -->|"七、社区与支持 提供链接"| CENTER
    README -->|"四、工程结构 描述目录"| DOCS
    DOCS --> PDF
    DOCS --> URL_FILES
    URL_FILES -->|"双击跳转"| CENTER
    DOCS --> SPHINX
    README -->|"八、版本历史 摘要"| PDF
    README -->|"报告问题"| ISSUES
    CENTER -->|"功能模块章节"| SPHINX

图中各节点的角色：

这种「仓库内自包含 + 线上权威发布」的设计意图：仓库内文档保证开发者离线或 clone 后即可查阅；线上文档中心保证文档可随 SDK 迭代持续更新而无需改动仓库；README 中的版本历史作为快速摘要，完整记录则以 PDF 形式沉淀在 docs/ 中，避免 README 过长。

文档产物结构

docs/document/ 是 Sphinx 文档构建后的产物目录，从仓库文件列表可见其章节划分：

docs/document/
├── doctrees/
│   ├── Development/Content/        # 开发章节
│   │   ├── api_desc.doctree        #   API 描述
│   │   ├── function_desc.doctree   #   功能描述
│   │   └── import.doctree          #   工程导入
│   ├── Framework/
│   │   └── framework.doctree       # 框架说明
│   ├── Other/
│   │   ├── contactUs.doctree       #   联系我们
│   │   ├── debug.doctree           #   调试
│   │   ├── jl_health_sdk_qa.doctree #  SDK 常见问题
│   │   ├── online.doctree          #   在线文档
│   │   └── version.doctree         #   版本记录
│   ├── resource/
│   │   └── index.doctree           # 资源索引
│   └── index.doctree               # 文档首页
└── html/                           # 渲染后的静态页面
    └── _images/                    # 流程图、架构图等图片资源

说明：doctrees/ 是 Sphinx 构建生成的二进制中间文件，html/ 为可直接浏览的静态页面，二者均属于构建产物，章节内容与在线文档中心一致。

在线文档渠道

README 双语文档

README.md 是仓库的「第一份文档」，采用锚点目录组织九大章节：概述、运行环境、快速开始、工程结构、配置说明、调试技巧、社区与支持、版本历史、许可证。英文版 README_EN.md 与之对应，供国际化开发者使用。顶栏集中提供四个关键入口：中文 README、English README、文档中心、SDK 版本历史、报告问题。

docs/ 目录资源

仓库 docs/ 目录下沉淀了四类离线资源（见 README.md 工程结构）：

.url 文件的设计意图：把线上文档的入口「物化」进仓库，开发者无需记忆 URL，双击即可到达对应章节；同时避免在仓库内维护容易过期的 HTML 副本。

在线文档中心

官方文档中心 https://doc.zh-jieli.com/ 是文档的权威线上来源，iOS 健康 SDK 接入文档主页为：

• SDK 接入文档：https://doc.zh-jieli.com/Apps/iOS/health/zh-cn/master/index.html

README「七、社区与支持」同时给出官方网站（https://www.zh-jieli.com/）与 GitHub Issues 问题反馈入口（https://github.com/Jieli-Tech/iOS-JL_Health/issues），形成「读文档 → 集成 → 反馈」的闭环。

版本历史

SDK 版本记录

README「八、版本历史」以表格形式维护 SDK 版本摘要（详见 README.md 版本历史），完整记录请参考 docs/ 目录下的发布记录文档：

注：README 中注明「详细的版本迭代记录请参考 docs 目录下的发布记录文档」，即 docs/Jieli_Health_SDK_iOS_Releases.pdf。

版本演进解读

从版本记录可以观察 SDK 能力演进的几个阶段：

flowchart LR
    V8["V1.8.0<br/>2023/04<br/>修复+模块化拆分"] --> V9["V1.9.0<br/>2023/09<br/>AI 云服务"]
    V9 --> V10["V1.10.0<br/>2024/01<br/>AI 表盘 / Nand Flash"]
    V10 --> V11["V1.11.0<br/>2024/03<br/>4G OTA / 表盘拓展"]
    V11 --> V12["V1.12.0<br/>2024/11<br/>AC707N 图像转换<br/>独立图像工具库"]
    V12 --> V13["V1.13.0(Beta)<br/>2026/03/02"]
    V13 --> V14["V1.14.0(Beta)<br/>2026/03/03"]

演进要点：

1. 稳定性筑基（V1.8.0）：修复小文件分包传输与大文件传输超时问题，同时对 SDK 库进行功能模块分离（将灯光控制、自定义命令等解耦），为后续独立业务库（JL_OTALib、JLAudioUnitKit、JLBmpConvertKit、JLDialUnit、JLPackageResKit）奠定基础。
2. AI 能力引入（V1.9.0–V1.10.0）：先引入 AI 云服务，再落地 AI 表盘功能与 Nand Flash 存储信息拓展，配合 README 功能清单中的「AI表盘」「AI云服务」。
3. 硬件适配与模块化收尾（V1.11.0–V1.12.0）：新增 4G 模块 OTA，表盘拓展参数补充 AI 表盘流程；V1.12.0 增加兼容 AC707N 的自定义表盘图像转换，并将图像转换工具分离为独立模块库（对应 JLBmpConvertKit.xcframework）。
4. Beta 迭代（V1.13.0–V1.14.0）：版本号快速更替，处于 Beta 阶段，主要动作为版本更替，表明 SDK 正在为下一正式版本做准备。

版本与库的对应关系

版本历史与 libs/ 目录中的 XCFramework 业务库一一对应：主业务库 JL_BLEKit.xcframework 承载健康数据、蓝牙连接等基础能力；JL_OTALib 承载 OTA（含 4G OTA）；JLDialUnit 承载表盘（含 AI 表盘）；JLBmpConvertKit 承载图像转换（V1.12.0 分离）；JLPackageResKit 承载资源打包。升级 SDK 版本时应同步替换对应的 XCFramework 并关注发布记录中的兼容性说明。

开发者文档使用流程

开发者从接触到使用本 SDK 的典型文档流程如下：

sequenceDiagram
    participant Dev as 开发者
    participant README as README.md
    participant DOCS as docs/ 目录
    participant CENTER as 文档中心 doc.zh-jieli.com
    participant ISSUES as GitHub Issues

    Dev->>README: 打开仓库，阅读概述/快速开始
    README-->>Dev: 功能清单、运行环境、集成步骤
    Dev->>README: 按需查看工程结构与配置说明
    README-->>Dev: libs/ 业务库清单、权限配置
    Dev->>DOCS: 需要完整发布记录
    DOCS-->>Dev: Jieli_Health_SDK_iOS_Releases.pdf
    Dev->>CENTER: 需要 API 细节/功能实现说明
    CENTER-->>Dev: api_desc / function_desc 等章节
    Dev->>README: 关注版本迭代
    README-->>Dev: 版本历史表（最新 V1.14.0 Beta）
    Dev->>ISSUES: 集成遇到问题
    ISSUES-->>Dev: 官方反馈与支持

流程要点：README 是「第一入口」，负责快速上手；docs/ 提供离线发布记录；文档中心提供完整 API 与功能说明；GitHub Issues 提供反馈闭环。四者职责互补，避免任何单一渠道承载全部信息。

使用示例

以下示例均提取自仓库实际文件，展示「在线文档与版本历史」如何被组织与引用。

示例 1：README 版本历史表（Markdown 源码）

README「八、版本历史」采用 Markdown 表格维护版本摘要，是仓库内最直接、最常用的版本查询入口：

## 八、版本历史

### SDK 版本

| 版本 | 发布日期 | 主要更新 |
|------|----------|----------|
| **V1.14.0(Beta)** | 2026/03/03 | 1. 新增功能<br/>(1) 更替 SDK 版本为 V1.14.0（Beta） |
| **V1.13.0(Beta)** | 2026/03/02 | 1. 新增功能<br/>(1) 更替 SDK 版本为 V1.13.0（Beta） |
| **V1.12.0** | 2024/11/22 | 1. 新增功能<br/>(1) 增加兼容 AC707N 的自定义表盘图像转换<br/>(2) 分离图像转换工具作为独立模块库 |
| **V1.11.0** | 2024/03/15 | 1. 新增功能<br/>(1) 增加 4G 模块 OTA 功能<br/>(2) 增加表盘拓展参数和补充 AI 表盘流程 |
| **V1.10.0** | 2024/01/05 | 1. 新增功能<br/>(1) 增加 AI 表盘功能<br/>(2) Nand Flash 存储器信息拓展支持 |
| **V1.9.0** | 2023/09/15 | 1. 新增功能<br/>(1) 增加 AI 云服务功能 |
| **V1.8.0** | 2023/04/23 | 1. 修复问题<br/>(1) 修复小文件分包传输出错问题<br/>(2) 修复大文件传输超时问题<br/>2. 新增功能<br/>(1) 设备录音接口完善，新增双向控制接口<br/>(2) 新增时间同步设置接口<br/>(3) 新增图片转码增加忽略头文件信息接口<br/>3. 性能优化<br/>(1) 优化 RTC 模块不足，扩展 RTC 可用长度<br/>(2) 对 SDK 库进行功能模块分离<br/>(3) 解耦灯光控制模块、优化删除表盘线程回调、优化自定义命令模块 |

> 注：详细的版本迭代记录请参考 docs 目录下的发布记录文档。

Source: README.md

设计意图：版本表放在 README 而非独立文件，保证开发者 clone 后无需任何额外操作即可确认「当前版本是否满足需求」；「发布日期」列用于判断版本新旧，「主要更新」列用 <br/> 换行组织「修复/新增/优化」三类变更，便于快速扫描。

示例 2：工程结构中的文档资源声明

README「四、工程结构」明确声明了 docs/ 目录下文档资源的组织方式：

└── docs/                           # 文档资源
    ├── Jieli_Health_SDK_iOS_Releases.pdf #   版本发布记录
    ├── 杰理OTA升级(iOS)开发说明.url      #   在线文档：OTA开发说明
    ├── 杰理健康SDK开发说明.url           #   在线文档：开发说明
    └── 自定义蓝牙接入方式.url             #   在线文档：接入方式介绍

Source: README.md

该结构说明文档资源与示例代码（code/）、SDK 库（libs/）并列存放，体现「代码 + 库 + 文档」三位一体的仓库设计：开发者在一个仓库内即可完成集成所需的全部素材获取。

示例 3：社区与支持中的在线文档入口

README「七、社区与支持」集中登记在线渠道链接，是「在线文档」部分的直接入口清单：

| 资源 | 链接 |
|------|------|
| 📖 **在线文档中心** | [https://doc.zh-jieli.com/](https://doc.zh-jieli.com/) |
| 📄 **SDK 接入文档** | [https://doc.zh-jieli.com/Apps/iOS/health/zh-cn/master/index.html](https://doc.zh-jieli.com/Apps/iOS/health/zh-cn/master/index.html) |
| 🌐 **官方网站** | [https://www.zh-jieli.com/](https://www.zh-jieli.com/) |
| 🐛 **问题反馈** | [https://github.com/Jieli-Tech/iOS-JL_Health/issues](https://github.com/Jieli-Tech/iOS-JL_Health/issues) |

Source: README.md

文档资源清单

注意事项与边界情况

• Beta 版本语义：V1.13.0 与 V1.14.0 均为 Beta 版本（2026/03 密集更替），生产环境集成时应评估 Beta 状态的风险，优先选择正式版本（如 V1.12.0）。
• 版本历史完整性：README 版本表只是摘要（自 V1.8.0 起），更早版本与细节变更需查阅 docs/Jieli_Health_SDK_iOS_Releases.pdf；仓库内 docs/document/doctrees/Other/version.doctree 是 Sphinx 构建产物（二进制），应通过在线文档中心浏览其渲染内容。
• 文档产物为构建生成：docs/document/doctrees/（pickle 文件）与 html/ 为构建产物，不应直接编辑；文档源文件的维护与发布经由在线文档中心流程完成。
• 在线链接失效风险：.url 文件与 README 中的外链指向在线服务，若链接失效请通过 GitHub Issues 反馈，官方渠道以 README「七、社区与支持」为准。
• 语言一致性：README 中英文版本内容应对应同步，集成时以当前分支（main）最新内容为准。

相关链接

• README.md（中文总览与版本历史）
• README_EN.md（英文总览）
• docs/document/doctrees/Development/Content/api_desc.doctree
• docs/document/doctrees/Development/Content/function_desc.doctree
• docs/document/doctrees/Framework/framework.doctree
• docs/document/doctrees/Other/jl_health_sdk_qa.doctree
• docs/document/doctrees/Other/version.doctree
• docs/document/doctrees/Other/online.doctree
• 在线文档中心
• SDK 接入文档主页
• GitHub Issues 问题反馈