anyone-can-architect 0.2.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (146) hide show
  1. package/CONTEXT.md +2 -2
  2. package/README.md +6 -4
  3. package/README.zh-CN.md +4 -2
  4. package/SSOT.md +5 -0
  5. package/VERSION +1 -1
  6. package/axioms/README.md +1 -1
  7. package/axioms/writing.md +3 -1
  8. package/dist/antigravity/aca/SKILL.md +3 -2
  9. package/dist/antigravity/aca-design/SKILL.md +12 -6
  10. package/dist/antigravity/aca-implement/SKILL.md +102 -114
  11. package/dist/antigravity/aca-release/SKILL.md +13 -20
  12. package/dist/antigravity/aca-repo-audit/SKILL.md +13 -9
  13. package/dist/antigravity/aca-review/SKILL.md +146 -182
  14. package/dist/antigravity/aca-test/SKILL.md +112 -0
  15. package/dist/antigravity/aca-walkthrough/SKILL.md +18 -14
  16. package/dist/antigravity-cli/aca/SKILL.md +3 -2
  17. package/dist/antigravity-cli/aca-design/SKILL.md +12 -6
  18. package/dist/antigravity-cli/aca-implement/SKILL.md +102 -114
  19. package/dist/antigravity-cli/aca-release/SKILL.md +13 -20
  20. package/dist/antigravity-cli/aca-repo-audit/SKILL.md +13 -9
  21. package/dist/antigravity-cli/aca-review/SKILL.md +146 -182
  22. package/dist/antigravity-cli/aca-test/SKILL.md +112 -0
  23. package/dist/antigravity-cli/aca-walkthrough/SKILL.md +18 -14
  24. package/dist/codex/aca/SKILL.md +3 -2
  25. package/dist/codex/aca-design/SKILL.md +12 -6
  26. package/dist/codex/aca-implement/SKILL.md +102 -114
  27. package/dist/codex/aca-release/SKILL.md +13 -20
  28. package/dist/codex/aca-repo-audit/SKILL.md +13 -9
  29. package/dist/codex/aca-review/SKILL.md +146 -182
  30. package/dist/codex/aca-test/SKILL.md +112 -0
  31. package/dist/codex/aca-walkthrough/SKILL.md +18 -14
  32. package/dist/cursor/aca/SKILL.md +3 -2
  33. package/dist/cursor/aca-design/SKILL.md +12 -6
  34. package/dist/cursor/aca-implement/SKILL.md +102 -114
  35. package/dist/cursor/aca-release/SKILL.md +13 -20
  36. package/dist/cursor/aca-repo-audit/SKILL.md +13 -9
  37. package/dist/cursor/aca-review/SKILL.md +146 -182
  38. package/dist/cursor/aca-test/SKILL.md +113 -0
  39. package/dist/cursor/aca-walkthrough/SKILL.md +18 -14
  40. package/dist/grok/aca/SKILL.md +3 -2
  41. package/dist/grok/aca-design/SKILL.md +12 -6
  42. package/dist/grok/aca-implement/SKILL.md +102 -114
  43. package/dist/grok/aca-release/SKILL.md +13 -20
  44. package/dist/grok/aca-repo-audit/SKILL.md +13 -9
  45. package/dist/grok/aca-review/SKILL.md +146 -182
  46. package/dist/grok/aca-test/SKILL.md +112 -0
  47. package/dist/grok/aca-walkthrough/SKILL.md +18 -14
  48. package/doc-design/document-sets/module.md +6 -2
  49. package/doc-design/document-sets/ops-guide.md +25 -27
  50. package/doc-design/documents/class-design.md +7 -4
  51. package/doc-design/documents/instrumentation.md +3 -2
  52. package/doc-design/documents/integration-guide.md +7 -5
  53. package/doc-design/documents/interaction.md +516 -143
  54. package/doc-design/documents/interface.md +12 -7
  55. package/doc-design/documents/release.md +137 -105
  56. package/doc-design/patterns/interface.md +135 -14
  57. package/doc-design/repo-types/client-sdk.md +3 -3
  58. package/doc-design/repo-types/web-app.md +11 -5
  59. package/meta-skills/aca/SKILL.md +3 -2
  60. package/meta-skills/aca/SKILL.md.tmpl +3 -2
  61. package/package.json +1 -1
  62. package/skills/aca-design/SKILL.md +12 -6
  63. package/skills/aca-design/SKILL.md.tmpl +9 -5
  64. package/skills/aca-implement/SKILL.md +102 -114
  65. package/skills/aca-implement/SKILL.md.tmpl +103 -115
  66. package/skills/aca-release/SKILL.md +13 -20
  67. package/skills/aca-release/SKILL.md.tmpl +13 -20
  68. package/skills/aca-repo-audit/SKILL.md +13 -9
  69. package/skills/aca-repo-audit/SKILL.md.tmpl +10 -8
  70. package/skills/aca-review/SKILL.md +146 -182
  71. package/skills/aca-review/SKILL.md.tmpl +143 -181
  72. package/skills/aca-test/SKILL.md +112 -0
  73. package/skills/aca-test/SKILL.md.tmpl +110 -0
  74. package/skills/aca-walkthrough/SKILL.md +18 -14
  75. package/skills/aca-walkthrough/SKILL.md.tmpl +15 -13
  76. package/zh-CN/CONTEXT.md +2 -2
  77. package/zh-CN/SSOT.md +5 -0
  78. package/zh-CN/axioms/README.md +1 -1
  79. package/zh-CN/axioms/writing.md +3 -1
  80. package/zh-CN/dist/antigravity/aca/SKILL.md +3 -2
  81. package/zh-CN/dist/antigravity/aca-design/SKILL.md +12 -6
  82. package/zh-CN/dist/antigravity/aca-implement/SKILL.md +102 -114
  83. package/zh-CN/dist/antigravity/aca-release/SKILL.md +71 -69
  84. package/zh-CN/dist/antigravity/aca-repo-audit/SKILL.md +39 -29
  85. package/zh-CN/dist/antigravity/aca-review/SKILL.md +143 -179
  86. package/zh-CN/dist/antigravity/aca-test/SKILL.md +112 -0
  87. package/zh-CN/dist/antigravity/aca-walkthrough/SKILL.md +18 -14
  88. package/zh-CN/dist/antigravity-cli/aca/SKILL.md +3 -2
  89. package/zh-CN/dist/antigravity-cli/aca-design/SKILL.md +12 -6
  90. package/zh-CN/dist/antigravity-cli/aca-implement/SKILL.md +102 -114
  91. package/zh-CN/dist/antigravity-cli/aca-release/SKILL.md +71 -69
  92. package/zh-CN/dist/antigravity-cli/aca-repo-audit/SKILL.md +39 -29
  93. package/zh-CN/dist/antigravity-cli/aca-review/SKILL.md +143 -179
  94. package/zh-CN/dist/antigravity-cli/aca-test/SKILL.md +112 -0
  95. package/zh-CN/dist/antigravity-cli/aca-walkthrough/SKILL.md +18 -14
  96. package/zh-CN/dist/codex/aca/SKILL.md +3 -2
  97. package/zh-CN/dist/codex/aca-design/SKILL.md +12 -6
  98. package/zh-CN/dist/codex/aca-implement/SKILL.md +102 -114
  99. package/zh-CN/dist/codex/aca-release/SKILL.md +71 -69
  100. package/zh-CN/dist/codex/aca-repo-audit/SKILL.md +39 -29
  101. package/zh-CN/dist/codex/aca-review/SKILL.md +143 -179
  102. package/zh-CN/dist/codex/aca-test/SKILL.md +112 -0
  103. package/zh-CN/dist/codex/aca-walkthrough/SKILL.md +18 -14
  104. package/zh-CN/dist/cursor/aca/SKILL.md +3 -2
  105. package/zh-CN/dist/cursor/aca-design/SKILL.md +12 -6
  106. package/zh-CN/dist/cursor/aca-implement/SKILL.md +102 -114
  107. package/zh-CN/dist/cursor/aca-release/SKILL.md +71 -69
  108. package/zh-CN/dist/cursor/aca-repo-audit/SKILL.md +39 -29
  109. package/zh-CN/dist/cursor/aca-review/SKILL.md +143 -179
  110. package/zh-CN/dist/cursor/aca-test/SKILL.md +113 -0
  111. package/zh-CN/dist/cursor/aca-walkthrough/SKILL.md +18 -14
  112. package/zh-CN/dist/grok/aca/SKILL.md +3 -2
  113. package/zh-CN/dist/grok/aca-design/SKILL.md +12 -6
  114. package/zh-CN/dist/grok/aca-implement/SKILL.md +102 -114
  115. package/zh-CN/dist/grok/aca-release/SKILL.md +71 -69
  116. package/zh-CN/dist/grok/aca-repo-audit/SKILL.md +39 -29
  117. package/zh-CN/dist/grok/aca-review/SKILL.md +143 -179
  118. package/zh-CN/dist/grok/aca-test/SKILL.md +112 -0
  119. package/zh-CN/dist/grok/aca-walkthrough/SKILL.md +18 -14
  120. package/zh-CN/doc-design/document-sets/module.md +6 -2
  121. package/zh-CN/doc-design/document-sets/ops-guide.md +25 -27
  122. package/zh-CN/doc-design/documents/class-design.md +7 -4
  123. package/zh-CN/doc-design/documents/instrumentation.md +3 -2
  124. package/zh-CN/doc-design/documents/integration-guide.md +7 -5
  125. package/zh-CN/doc-design/documents/interaction.md +516 -143
  126. package/zh-CN/doc-design/documents/interface.md +12 -7
  127. package/zh-CN/doc-design/documents/release.md +138 -106
  128. package/zh-CN/doc-design/patterns/interface.md +135 -14
  129. package/zh-CN/doc-design/repo-types/client-sdk.md +3 -3
  130. package/zh-CN/doc-design/repo-types/web-app.md +11 -5
  131. package/zh-CN/meta-skills/aca/SKILL.md +3 -2
  132. package/zh-CN/meta-skills/aca/SKILL.md.tmpl +3 -2
  133. package/zh-CN/skills/aca-design/SKILL.md +12 -6
  134. package/zh-CN/skills/aca-design/SKILL.md.tmpl +9 -5
  135. package/zh-CN/skills/aca-implement/SKILL.md +102 -114
  136. package/zh-CN/skills/aca-implement/SKILL.md.tmpl +102 -114
  137. package/zh-CN/skills/aca-release/SKILL.md +71 -69
  138. package/zh-CN/skills/aca-release/SKILL.md.tmpl +71 -69
  139. package/zh-CN/skills/aca-repo-audit/SKILL.md +39 -29
  140. package/zh-CN/skills/aca-repo-audit/SKILL.md.tmpl +36 -28
  141. package/zh-CN/skills/aca-review/SKILL.md +143 -179
  142. package/zh-CN/skills/aca-review/SKILL.md.tmpl +140 -178
  143. package/zh-CN/skills/aca-test/SKILL.md +112 -0
  144. package/zh-CN/skills/aca-test/SKILL.md.tmpl +110 -0
  145. package/zh-CN/skills/aca-walkthrough/SKILL.md +18 -14
  146. package/zh-CN/skills/aca-walkthrough/SKILL.md.tmpl +15 -13
@@ -75,7 +75,10 @@ docs/design/module-order/
75
75
  1. interface
76
76
  2. class-design,有子模块时先确定内部组成与各子模块的职责边界
77
77
  3. 按子模块之间的依赖关系编写各子模块,被依赖的子模块先编写,每个子模块同样按本步骤的顺序编写
78
- 4. 核对父级 class-design 的子模块协作与各子级 interface 一致
78
+ 4. 回查父级 class-design,核对父子边界
79
+ - 父级的子模块调用、输入转换与结果处理与各子级 interface 一致
80
+ - 父级不直接操作子级内部字段,不调用子级 interface 未声明的方法
81
+ - 归属子级的数据结构、状态机、算法与内部测试已在子级完整承接,并从父级移除
79
82
  5. testcase
80
83
  6. README
81
84
 
@@ -86,6 +89,7 @@ docs/design/module-order/
86
89
  - [ ] 每层模块包含固定四个文件,各文件满足对应文档设计
87
90
  - [ ] README 链接模块内三篇文档,有子模块时链接各子模块 README
88
91
  - [ ] 每个子模块满足拆分条件,不满足的能力留在父级 class-design
89
- - [ ] 父级 class-design 引用子级 interface,没有复述子级的契约与实现
92
+ - [ ] 父级 class-design 只通过子级 interface 已声明的能力协作,没有直接操作子级内部字段或调用未声明的方法
93
+ - [ ] 父级 class-design 没有保留已归属子级的数据结构、状态机、算法与子级内部测试
90
94
  - [ ] 父级对外提供的能力都在父级 interface 中声明
91
95
  - [ ] 每层 testcase 只以本层 interface 为黑盒边界,同一测试用例只归属一个层级
@@ -2,12 +2,13 @@
2
2
 
3
3
  ## 1 适用场景
4
4
 
5
- 适用于以工程产生的数据支持分析判断与运营动作,并持续核对动作效果的项目
5
+ 适用于本工程需要向运营或数据平台使用者提供数据采集、分析方法或运营动作指导的项目
6
6
 
7
7
  ## 2 文档组成
8
8
 
9
- 数据采集、数据分析与运营动作分别承担独立职责,各用一篇指南说明
10
- 文档放在工程类型规定的运营指南目录,固定四个文件
9
+ 运营指南目录与三类指南均按需建立
10
+ 没有指南需求时,可以不建立 `ops-guide/` 目录
11
+ 文档放在工程类型规定的运营指南目录,选用条件与文件名见下表
11
12
 
12
13
  ```text
13
14
  ops-guide/
@@ -17,16 +18,16 @@ ops-guide/
17
18
  └─ ops-actions.md
18
19
  ```
19
20
 
20
- | 文件 | 职责 |
21
- | --- | --- |
22
- | `README.md` | 说明运营目标、三篇指南的关系与执行入口 |
23
- | [data-collection.md](../documents/data-collection.md) | 说明原始数据来源、获取方法与数据定义 |
24
- | [data-analysis.md](../documents/data-analysis.md) | 汇总分析指标,逐项说明分析方法与可选的可视化方式 |
25
- | [ops-actions.md](../documents/ops-actions.md) | 按章说明允许执行的动作、操作方法与结果确认方式,按需说明操作依据 |
21
+ | 文件 | 必要条件 | 职责 |
22
+ | --- | --- | --- |
23
+ | `README.md` | 建立运营指南目录 | 说明已选用指南的用途、关系与执行入口 |
24
+ | [data-collection.md](../documents/data-collection.md) | 需要本工程提供数据获取与定义说明 | 说明原始数据来源、获取方法与数据定义 |
25
+ | [data-analysis.md](../documents/data-analysis.md) | 需要本工程提供指标分析指导 | 汇总指标,逐项说明分析方法与可选的可视化方式 |
26
+ | [ops-actions.md](../documents/ops-actions.md) | 需要本工程提供运营动作指导 | 说明允许执行的动作、操作方法与结果确认方式,按需说明操作依据 |
26
27
 
27
28
  README 按 [readme 文档设计](../documents/readme.md)组织入口与导航
28
- 三篇指南分别按自身职责组织内容,具体章节结构由各自的文档设计规定
29
- 运营目标通过跨文档引用串联
29
+ 已选用的指南分别按自身职责组织内容,具体章节结构由各自的文档设计规定
30
+ 数据获取涉及导出、解密或解析时,操作说明归入 [data-collection](../documents/data-collection.md#2-文档结构) 的获取方法
30
31
 
31
32
  ### 2.1 输入输出关系
32
33
 
@@ -43,26 +44,23 @@ README 按 [readme 文档设计](../documents/readme.md)组织入口与导航
43
44
  工程产生的事件与参数引用 [instrumentation](../documents/instrumentation.md),不重复定义
44
45
  2. 集中定义共用内容
45
46
  优先在负责该内容的指南中统一说明
46
- 确需独立维护并供多个场景复用时,再单独成篇
47
47
  3. 保留当前场景的信息
48
48
  引用共用方法时,写清选用的方法、适用条件、输入或参数,以及预期结果
49
49
 
50
50
  ## 3 治理顺序
51
51
 
52
- 1. 确定运营目标与三篇指南的输入输出关系
53
- 明确分析要回答的问题及所需数据
54
- 核对工程能够提供的数据与实际可采取的动作
55
- 2. 编写数据采集指南
52
+ 1. 确定本工程需要提供的指南,按[文档组成](#2-文档组成)选用文件
53
+ 核对所需数据、分析方法与允许执行的动作,定位已有定义
54
+ 2. 需要数据获取与定义说明时,编写数据采集指南
56
55
  明确原始数据来源、获取方法与数据定义
57
- 3. 编写数据分析指南
56
+ 3. 需要指标分析指导时,编写数据分析指南
58
57
  汇总指标,逐项说明分析方法与可选的可视化方式
59
- 所需原始数据来源或定义缺失时,回到第 2 步补齐
60
- 4. 编写运营动作指南
58
+ 所需原始数据来源或定义缺失时,补齐对应内容或引用
59
+ 4. 需要运营动作指导时,编写运营动作指南
61
60
  按章说明允许执行的动作、操作方法与结果确认方式
62
- 依赖分析指标时补齐引用,指标缺失时回到第 3 步补齐
61
+ 依赖分析指标时,补齐对应内容或引用
63
62
  5. 完善 README 与跨文档引用
64
- 修改影响其他指南时,同步更新输入输出与引用
65
- 从运营目标出发,核对采集、分析、动作及下一轮数据之间的衔接
63
+ 汇总已选用指南的用途与执行入口,核对各自所需的输入及结果确认方式
66
64
 
67
65
  工程能力或业务决定不足时,记录具体缺口,交由输入提供方确认后继续编写
68
66
  指南不自行补出未经确认的工程能力
@@ -70,11 +68,11 @@ README 按 [readme 文档设计](../documents/readme.md)组织入口与导航
70
68
 
71
69
  ## 4 检查条件
72
70
 
73
- - [ ] 选用文档组后,固定四个文件均已建立,各自职责明确
74
- - [ ] README 说明运营目标、三篇指南的关系,并提供有效入口
75
- - [ ] 原始数据来源、获取方法与数据定义齐全,可直接查阅或通过引用定位
76
- - [ ] 指标汇总能够定位到各指标章节,分析方法明确,可视化按需说明
77
- - [ ] 允许执行的动作、操作方法与结果确认方式明确
71
+ - [ ] 目录与指南按本工程实际需要选用,文件名符合文档组成
72
+ - [ ] 建立目录时,README 说明已选用指南的用途、关系与执行入口
73
+ - [ ] 选用数据采集指南时,原始数据来源、获取方法与数据定义齐全
74
+ - [ ] 选用数据分析指南时,指标汇总能够定位到各指标章节,分析方法明确
75
+ - [ ] 选用运营动作指南时,允许执行的动作、操作方法与结果确认方式明确
78
76
  - [ ] 通过数据评价动作效果时,所需数据与分析指标能够定位
79
77
  - [ ] 分析指南引用所需原始数据,动作依赖分析指标时引用对应指标章节
80
78
  - [ ] 共用口径与规则只在一处定义,引用能够定位
@@ -18,8 +18,11 @@
18
18
  「内部机制」由「内部组成」与公共机制构成
19
19
 
20
20
  「内部机制」的第一个 [chapter](../../CONTEXT.md#chapter) 为「内部组成」
21
- - 无子模块时,列出本模块的类或组件、本模块拥有的数据与依赖的下游模块或外部系统
22
- - 有子模块时,以模块表列出子模块、能力与责任边界,以关系表列出子模块之间的协作,子模块名链接对应 README
21
+ - 列出本模块的类或组件、本模块拥有的数据与依赖的下游模块或外部系统
22
+ - 有子模块时,按以下规则组织本层与直接子模块
23
+ - 组成图将每个直接子模块作为一个整体节点,表达本模块结构、直接子模块及它们之间的调用与反馈关系
24
+ - 不绘制子模块内部的类、状态、算法与更深层子模块
25
+ - 以模块表列出直接子模块、能力与责任边界,子模块名链接对应 README,能力链接子级 interface
23
26
 
24
27
  「内部组成」之后为公共机制,每个公共机制一个 [chapter](../../CONTEXT.md#chapter),没有公共机制时不设
25
28
  公共机制须同时满足以下条件
@@ -36,7 +39,7 @@
36
39
 
37
40
  ```text
38
41
  「内部机制」
39
- ## 1 内部组成 类或组件、拥有的数据与依赖 · 有子模块时为模块表与关系表
42
+ ## 1 内部组成 类或组件、拥有的数据与依赖 · 有子模块时含直接子模块表
40
43
  ## 2 <公共机制> 按需,满足公共机制条件才设
41
44
  …
42
45
  「对外能力」
@@ -134,7 +137,7 @@
134
137
 
135
138
  ## 5 检查条件
136
139
 
137
- - [ ] 第一章为「内部组成」,有子模块时与子模块目录一致,子模块的能力只链接子级 interface
140
+ - [ ] 第一章为「内部组成」,有子模块时只展开本层与直接子模块,与直接子模块目录一致,子模块的能力只链接子级 interface
138
141
  - [ ] 每个公共机制章都满足公共机制条件,能列出至少两个使用它的对外能力
139
142
  - [ ] 「对外能力」的 [chapter](../../CONTEXT.md#chapter) 与 [section](../../CONTEXT.md#section) 与 interface 一一对应,排在「内部机制」之后,编号连续
140
143
  - [ ] 「内部机制」与每个「对外能力」都层层深入到叶子,模块的实现只有一种
@@ -7,6 +7,7 @@
7
7
 
8
8
  ## 2 文档结构
9
9
 
10
+ 本文件由承担业务数据记录职责的一方维护
10
11
  正文包含以下三章
11
12
 
12
13
  | 章节 | 内容要求 |
@@ -19,7 +20,7 @@
19
20
 
20
21
  明确采用打点 SDK、日志或其他方式记录数据,以及记录由谁产生、如何送达何处
21
22
  依赖接入方实现时,写清接入方的责任,并在接入指南中引用
22
- 多端共同设计时,各端分别说明自己的记录职责,通过引用衔接
23
+ 多端共同设计时,由实际记录方定义事件与参数,其他端引用对应定义
23
24
 
24
25
  ### 2.2 事件汇总
25
26
 
@@ -43,7 +44,7 @@ parent 按参数的完整父级路径确定,所有事件的顶层参数视为
43
44
 
44
45
  ## 3 行文步骤
45
46
 
46
- 1. 明确记录方式、数据去向与各方责任,引用已有基础设施或第三方能力设计
47
+ 1. 确定实际记录方,明确记录方式、数据去向与各方责任,引用已有基础设施或第三方能力设计
47
48
  2. 汇总事件,为每个事件确定唯一的 event name、含义与打点时机
48
49
  3. 按事件编写明细,先列参数表,再展开所需的数据结构
49
50
  4. 跨事件核对相同 parent 下的同名 key,统一类型及数据形式约束,存在冲突时调整名称
@@ -48,9 +48,10 @@
48
48
  - 按操作顺序说明制品取得、安装、认证与配置,并提供完成后的确认方式
49
49
  - 凭据与用户专属值说明取得方式和配置位置,示例从配置读取
50
50
  3. 展开接入流程与使用场景
51
- - 描述调用时机、操作顺序、输入来源、结果与失败处理
52
- - 涉及回调、重试或重复操作时,说明接入方必须承担的处理
53
- - 按操作需要提供可执行的最小示例,局部示例标明放入完整流程的位置
51
+ - 可用代码表达的接入场景:以可复制运行的代码为主体,完整写出调用顺序、订阅与解绑、回调处理、重试或重复操作处理及生命周期管理
52
+ - 参数用途、调用条件与语句自身无法表达的约束就近写入代码注释,不注释显然的语法
53
+ - 正文只写代码之外必需的操作与完成结果,如文件放置、挂载对象、编辑器配置及外部验证结果,不复述代码已表达的调用与参数
54
+ - 局部代码片段标明放入完整示例的位置及必需配套代码,不使用未定义的辅助方法或空实现冒充可复制代码
54
55
  4. 补充调试与验证,以及所需 FAQ
55
56
  - 定义整体接入的检查步骤与通过条件
56
57
  - 根据使用者可获得的错误、状态与日志提供定位和恢复方式,使用场景引用对应内容
@@ -242,8 +243,9 @@ curl --fail-with-body "$REPORT_ENDPOINT/reports/$REPORT_ID/file" \
242
243
  - [ ] 结构符合接入形态,使用内容按流程或业务场景组织
243
244
  - [ ] 环境、依赖、安装、认证与配置按实际顺序说明,所需信息有取得方式
244
245
  - [ ] 场景所需能力完整,适用条件、操作步骤、完成结果与失败后的处理已定义
245
- - [ ] 调用方式与接口契约一致,回调、重试及重复操作的责任已交代
246
- - [ ] 最小示例可按所述步骤执行,局部示例标明放入完整流程的位置
246
+ - [ ] 调用方式与接口契约一致,可用代码表达的场景以可复制运行的代码为主体,必需接线、回调、解绑、重试及重复操作均在代码中实现
247
+ - [ ] 参数用途、调用条件与语句自身无法表达的约束就近写入代码注释,正文没有复述代码已表达的调用与参数
248
+ - [ ] 示例可按所述步骤执行,依赖与参数替换位置齐全,局部代码片段标明放入完整示例的位置及必需配套代码
247
249
  - [ ] 整体验证有可执行动作与可观察结果,异常有定位或反馈方式
248
250
  - [ ] 手册与实际制品、接口及随包资料一致,不依赖内部设计文档
249
251
  - [ ] 没有实际凭据值,用户专属配置有来源与使用位置