@ohos-cpf/3rdloop 0.0.2 → 0.0.3

package/vendor/Server/Skills/rnoh-lib-demo-doc/references/QUALITY_CHECKLIST.md

@@ -1,98 +1,98 @@
-# 质量检查清单
-
-> Demo 描述文档生成后的完整质量校验清单。生成文档前逐项检查，确保输出质量。
-
----
-
-## 1. 接口覆盖完整性
-
-| # | 检查项 | 标准 | 通过条件 |
-|---|--------|------|----------|
-| 1.1 | 接口覆盖完整性 | 规格中所有**待生成**接口（Phase 4 过滤后）至少被一个 Demo 覆盖 | ✅ 全部覆盖 |
-| 1.2 | 无接口遗漏 | 接口覆盖矩阵中无"未覆盖"状态 | ✅ 全部 ✅ 已覆盖/本次新增 |
-| 1.3 | iOS/Android 接口排除 | 已确认移除所有 README「HarmonyOS Support」标注为 `no` 的接口 | ✅ 已排除 |
-| 1.4 | 跨平台接口优先 | 跨平台接口和 HarmonyOS 支持的接口已优先生成 Demo | ✅ 已优先 |
-| 1.5 | 无标注接口处理 | README 中未列出或无平台标注的接口已生成 Demo，并在预期结果中建议验证 | ✅ 已处理 |
-| 1.6 | 增量模式一致性 | 增量模式下，输出文档中不包含已覆盖接口的 Demo（与覆盖率报告一致） | ✅ 一致 |
-| 1.7 | 增量模式统计准确 | 增量模式概述中，总接口数/已覆盖数/本次生成数与覆盖率报告一致 | ✅ 准确 |
-| 1.8 | 平台过滤依据 | 平台过滤**仅依据 README 文档**标注，未使用源码（`Platform.OS` 分支、TurboModule Spec、原生实现）作为过滤依据 | ✅ 仅依据文档 |
-| 1.9 | 未列出接口保留 | README 中未列出的接口视为无平台标注，已保留并生成 Demo（不因源码缺失实现而排除） | ✅ 已保留 |
-| 1.10 | 排除依据可追溯 | 排除的接口在文档中标注了 README 行号和标注值（`no`），排除依据可追溯 | ✅ 可追溯 |
-| 1.11 | 未列出接口诊断指标 | README 未列出的接口在 Demo 预期结果中设计了诊断指标（如回调未触发计数器保持 0），用于发现适配遗漏 | ✅ 已设计 |
-
----
-
-## 2. 内容真实性
-
-| # | 检查项 | 标准 | 通过条件 |
-|---|--------|------|----------|
-| 2.1 | 接口名称一致 | 所有接口名称与接口规格 JSON / 说明书严格一致 | ✅ 无差异 |
-| 2.2 | 参数类型一致 | 所有参数类型与接口规格严格一致 | ✅ 无差异 |
-| 2.3 | 返回值一致 | 所有返回值类型与接口规格严格一致 | ✅ 无差异 |
-| 2.4 | 无捏造接口 | 未出现规格中不存在的接口、参数或行为 | ✅ 全部真实 |
-| 2.5 | 源码补充合理 | 源码补充的默认值、错误码等信息与源码实现一致 | ✅ 一致 |
-
----
-
-## 3. 步骤可执行性
-
-| # | 检查项 | 标准 | 通过条件 |
-|---|--------|------|----------|
-| 3.1 | 步骤具体性 | 步骤描述足够具体，开发者可按步骤实现 RN Demo 页面 | ✅ 可执行 |
-| 3.2 | 组件构建明确 | 步骤中说明了需要哪些 RN 组件（TouchableOpacity、TextInput、Text 等） | ✅ 明确 |
-| 3.3 | 状态声明明确 | 步骤中明确 useState 变量及初始值 | ✅ 明确 |
-| 3.4 | 交互触发明确 | 步骤中明确用户操作（点击什么按钮）和调用时机 | ✅ 明确 |
-| 3.5 | 参数传递明确 | 步骤中说明传入参数来源/示例值 | ✅ 明确 |
-| 3.6 | 状态更新明确 | 步骤中说明如何通过 setXxx() 更新状态 | ✅ 明确 |
-| 3.7 | 结果展示明确 | 步骤中说明如何在页面显示结果 | ✅ 明确 |
-
----
-
-## 4. 预期结果可验证性
-
-| # | 检查项 | 标准 | 通过条件 |
-|---|--------|------|----------|
-| 4.1 | 预期结果可观测 | 每条预期结果可观测、可判断 | ✅ 全部可观测 |
-| 4.2 | 无死按钮 | Demo 中每个可触发接口调用的按钮都有设备可观测的预期结果 | ✅ 无死按钮 |
-| 4.3 | iOS/Android 事件排除 | 依赖 iOS/Android 平台事件的接口不作为主测试步骤 | ✅ 已排除 |
-| 4.4 | HarmonyOS 预期标注 | 特别标注 HarmonyOS 平台的预期行为 | ✅ 已标注 |
-| 4.5 | 可用性验证建议 | README 中未列出或无平台标注的接口在预期结果中建议验证实际可用性 | ✅ 已建议 |
-| 4.6 | 适配遗漏诊断指标 | README 未列出的接口在预期结果中设计了诊断指标（如"若回调未触发，可能为鸿蒙化适配遗漏"），用于发现适配遗漏 | ✅ 已设计 |
-
----
-
-## 5. useState 完整性
-
-| # | 检查项 | 标准 | 通过条件 |
-|---|--------|------|----------|
-| 5.1 | setter 更新注明 | Demo 步骤/预期结果中所有计数器、状态标志变量都注明须通过 `setXxx()` 更新 | ✅ 已注明 |
-| 5.2 | 双计数器设计 | 异步回调链 Demo 已规划双计数器（callCount + callbackCount） | ✅ 已规划 |
-| 5.3 | 双计数器展示 | 两个计数器都在验证区域用 `<Text>` 展示 | ✅ 已展示 |
-| 5.4 | 双计数器 setter | 两个计数器都通过 `useState` 的 setter 函数更新 | ✅ 已使用 setter |
-
----
-
-## 6. Demo 设计质量
-
-| # | 检查项 | 标准 | 通过条件 |
-|---|--------|------|----------|
-| 6.1 | Demo 名称清晰 | 名称能准确反映 Demo 的核心目的，≤20字 | ✅ 清晰 |
-| 6.2 | Demo 描述充分 | 2-4 句话，说明功能、目的、覆盖接口，标注 HarmonyOS 特性 | ✅ 充分 |
-| 6.3 | 分组合理 | 关联接口已合并，无无关合并 | ✅ 合理 |
-| 6.4 | 生成策略优先级 | P0 核心功能 → P1 完整流程/权限/组合 → P2 参数变体 | ✅ 按优先级 |
-| 6.5 | 平台差异标注 | 接口行为在 HarmonyOS 与 iOS/Android 存在差异时已标注 | ✅ 已标注 |
-
----
-
-## 7. 文档结构合规
-
-| # | 检查项 | 标准 | 通过条件 |
-|---|--------|------|----------|
-| 7.1 | 文件命名 | `{库名}RN测试demo描述.md` | ✅ 合规 |
-| 7.2 | 概述章节 | 包含文档目的、**来源声明（与实际路径一致）**、平台说明；增量模式额外含覆盖率来源和接口统计 | ✅ 存在 |
-| 7.3 | 来源声明准确性 | 快捷路径下概述**不得**提及 interface-spec.json 或接口规格说明书；来源声明与实际数据源一致 | ✅ 准确 |
-| 7.4 | 模式标识 | 增量模式下概述中标注"增量模式"及覆盖率报告来源 | ✅ 已标注 |
-| 7.5 | Demo 总览表 | 包含 Demo 数量、接口数量、生成日期 | ✅ 存在 |
-| 7.6 | Demo 描述列表 | 六列表格（序号、名称、描述、步骤、预期结果、对应接口） | ✅ 完整 |
-| 7.7 | 接口覆盖矩阵 | 四列表格（序号、接口名称、所在 Demo、覆盖状态） | ✅ 完整 |
-| 7.8 | 序号连续 | Demo 和矩阵的序号分别独立连续 | ✅ 连续 |
+# 质量检查清单
+
+> Demo 描述文档生成后的完整质量校验清单。生成文档前逐项检查，确保输出质量。
+
+---
+
+## 1. 接口覆盖完整性
+
+| # | 检查项 | 标准 | 通过条件 |
+|---|--------|------|----------|
+| 1.1 | 接口覆盖完整性 | 规格中所有**待生成**接口（Phase 4 过滤后）至少被一个 Demo 覆盖 | ✅ 全部覆盖 |
+| 1.2 | 无接口遗漏 | 接口覆盖矩阵中无"未覆盖"状态 | ✅ 全部 ✅ 已覆盖/本次新增 |
+| 1.3 | iOS/Android 接口排除 | 已确认移除所有 README「HarmonyOS Support」标注为 `no` 的接口 | ✅ 已排除 |
+| 1.4 | 跨平台接口优先 | 跨平台接口和 HarmonyOS 支持的接口已优先生成 Demo | ✅ 已优先 |
+| 1.5 | 无标注接口处理 | README 中未列出或无平台标注的接口已生成 Demo，并在预期结果中建议验证 | ✅ 已处理 |
+| 1.6 | 增量模式一致性 | 增量模式下，输出文档中不包含已覆盖接口的 Demo（与覆盖率报告一致） | ✅ 一致 |
+| 1.7 | 增量模式统计准确 | 增量模式概述中，总接口数/已覆盖数/本次生成数与覆盖率报告一致 | ✅ 准确 |
+| 1.8 | 平台过滤依据 | 平台过滤**仅依据 README 文档**标注，未使用源码（`Platform.OS` 分支、TurboModule Spec、原生实现）作为过滤依据 | ✅ 仅依据文档 |
+| 1.9 | 未列出接口保留 | README 中未列出的接口视为无平台标注，已保留并生成 Demo（不因源码缺失实现而排除） | ✅ 已保留 |
+| 1.10 | 排除依据可追溯 | 排除的接口在文档中标注了 README 行号和标注值（`no`），排除依据可追溯 | ✅ 可追溯 |
+| 1.11 | 未列出接口诊断指标 | README 未列出的接口在 Demo 预期结果中设计了诊断指标（如回调未触发计数器保持 0），用于发现适配遗漏 | ✅ 已设计 |
+
+---
+
+## 2. 内容真实性
+
+| # | 检查项 | 标准 | 通过条件 |
+|---|--------|------|----------|
+| 2.1 | 接口名称一致 | 所有接口名称与接口规格 JSON / 说明书严格一致 | ✅ 无差异 |
+| 2.2 | 参数类型一致 | 所有参数类型与接口规格严格一致 | ✅ 无差异 |
+| 2.3 | 返回值一致 | 所有返回值类型与接口规格严格一致 | ✅ 无差异 |
+| 2.4 | 无捏造接口 | 未出现规格中不存在的接口、参数或行为 | ✅ 全部真实 |
+| 2.5 | 源码补充合理 | 源码补充的默认值、错误码等信息与源码实现一致 | ✅ 一致 |
+
+---
+
+## 3. 步骤可执行性
+
+| # | 检查项 | 标准 | 通过条件 |
+|---|--------|------|----------|
+| 3.1 | 步骤具体性 | 步骤描述足够具体，开发者可按步骤实现 RN Demo 页面 | ✅ 可执行 |
+| 3.2 | 组件构建明确 | 步骤中说明了需要哪些 RN 组件（TouchableOpacity、TextInput、Text 等） | ✅ 明确 |
+| 3.3 | 状态声明明确 | 步骤中明确 useState 变量及初始值 | ✅ 明确 |
+| 3.4 | 交互触发明确 | 步骤中明确用户操作（点击什么按钮）和调用时机 | ✅ 明确 |
+| 3.5 | 参数传递明确 | 步骤中说明传入参数来源/示例值 | ✅ 明确 |
+| 3.6 | 状态更新明确 | 步骤中说明如何通过 setXxx() 更新状态 | ✅ 明确 |
+| 3.7 | 结果展示明确 | 步骤中说明如何在页面显示结果 | ✅ 明确 |
+
+---
+
+## 4. 预期结果可验证性
+
+| # | 检查项 | 标准 | 通过条件 |
+|---|--------|------|----------|
+| 4.1 | 预期结果可观测 | 每条预期结果可观测、可判断 | ✅ 全部可观测 |
+| 4.2 | 无死按钮 | Demo 中每个可触发接口调用的按钮都有设备可观测的预期结果 | ✅ 无死按钮 |
+| 4.3 | iOS/Android 事件排除 | 依赖 iOS/Android 平台事件的接口不作为主测试步骤 | ✅ 已排除 |
+| 4.4 | HarmonyOS 预期标注 | 特别标注 HarmonyOS 平台的预期行为 | ✅ 已标注 |
+| 4.5 | 可用性验证建议 | README 中未列出或无平台标注的接口在预期结果中建议验证实际可用性 | ✅ 已建议 |
+| 4.6 | 适配遗漏诊断指标 | README 未列出的接口在预期结果中设计了诊断指标（如"若回调未触发，可能为鸿蒙化适配遗漏"），用于发现适配遗漏 | ✅ 已设计 |
+
+---
+
+## 5. useState 完整性
+
+| # | 检查项 | 标准 | 通过条件 |
+|---|--------|------|----------|
+| 5.1 | setter 更新注明 | Demo 步骤/预期结果中所有计数器、状态标志变量都注明须通过 `setXxx()` 更新 | ✅ 已注明 |
+| 5.2 | 双计数器设计 | 异步回调链 Demo 已规划双计数器（callCount + callbackCount） | ✅ 已规划 |
+| 5.3 | 双计数器展示 | 两个计数器都在验证区域用 `<Text>` 展示 | ✅ 已展示 |
+| 5.4 | 双计数器 setter | 两个计数器都通过 `useState` 的 setter 函数更新 | ✅ 已使用 setter |
+
+---
+
+## 6. Demo 设计质量
+
+| # | 检查项 | 标准 | 通过条件 |
+|---|--------|------|----------|
+| 6.1 | Demo 名称清晰 | 名称能准确反映 Demo 的核心目的，≤20字 | ✅ 清晰 |
+| 6.2 | Demo 描述充分 | 2-4 句话，说明功能、目的、覆盖接口，标注 HarmonyOS 特性 | ✅ 充分 |
+| 6.3 | 分组合理 | 关联接口已合并，无无关合并 | ✅ 合理 |
+| 6.4 | 生成策略优先级 | P0 核心功能 → P1 完整流程/权限/组合 → P2 参数变体 | ✅ 按优先级 |
+| 6.5 | 平台差异标注 | 接口行为在 HarmonyOS 与 iOS/Android 存在差异时已标注 | ✅ 已标注 |
+
+---
+
+## 7. 文档结构合规
+
+| # | 检查项 | 标准 | 通过条件 |
+|---|--------|------|----------|
+| 7.1 | 文件命名 | `{库名}RN测试demo描述.md` | ✅ 合规 |
+| 7.2 | 概述章节 | 包含文档目的、**来源声明（与实际路径一致）**、平台说明；增量模式额外含覆盖率来源和接口统计 | ✅ 存在 |
+| 7.3 | 来源声明准确性 | 快捷路径下概述**不得**提及 interface-spec.json 或接口规格说明书；来源声明与实际数据源一致 | ✅ 准确 |
+| 7.4 | 模式标识 | 增量模式下概述中标注"增量模式"及覆盖率报告来源 | ✅ 已标注 |
+| 7.5 | Demo 总览表 | 包含 Demo 数量、接口数量、生成日期 | ✅ 存在 |
+| 7.6 | Demo 描述列表 | 六列表格（序号、名称、描述、步骤、预期结果、对应接口） | ✅ 完整 |
+| 7.7 | 接口覆盖矩阵 | 四列表格（序号、接口名称、所在 Demo、覆盖状态） | ✅ 完整 |
+| 7.8 | 序号连续 | Demo 和矩阵的序号分别独立连续 | ✅ 连续 |