artifact-chain-assistant 0.8.0 → 0.8.2
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.
- package/.claude-plugin/plugin.json +18 -3
- package/.codex-plugin/plugin.json +4 -13
- package/AGENT-METHOD-REGISTRY.md +238 -0
- package/AGENT-METHOD-REGISTRY.zh-CN.md +229 -0
- package/CHANGELOG.md +29 -0
- package/CONTRIBUTING.md +6 -1
- package/EXTENDED-ARTIFACT-CATALOG.md +3 -0
- package/EXTENDED-ARTIFACT-CATALOG.zh-CN.md +3 -0
- package/INSTALL.md +30 -16
- package/README.md +59 -275
- package/README.zh-CN.md +24 -176
- package/adapters/claude/.claude-plugin/plugin.json +18 -3
- package/adapters/claude/EXTENDED-ARTIFACT-CATALOG.md +3 -0
- package/adapters/claude/EXTENDED-ARTIFACT-CATALOG.zh-CN.md +3 -0
- package/adapters/claude/INSTALL.md +33 -16
- package/adapters/claude/agent-methods/catalog.yaml +40 -4
- package/adapters/claude/compatibility.json +4 -4
- package/adapters/claude/scripts/lib/compatibility-policy.mjs +0 -65
- package/adapters/claude/skills/artifact-chain-bootstrap/SKILL.md +1 -1
- package/adapters/claude/skills/artifact-chain-maintainer/SKILL.md +1 -1
- package/adapters/claude/skills/artifact-review/SKILL.md +1 -1
- package/adapters/claude/skills/help/SKILL.md +96 -0
- package/adapters/claude/skills/prd-feature/author/references/compose.md +43 -0
- package/adapters/claude/skills/prd-feature/author/references/inspect.md +94 -0
- package/adapters/claude/skills/prd-feature/author/references/validate.md +65 -0
- package/adapters/claude/skills/prd-feature/review/references/compose.md +43 -0
- package/adapters/claude/skills/prd-feature/review/references/inspect.md +94 -0
- package/adapters/claude/skills/prd-feature/review/references/validate.md +65 -0
- package/adapters/claude/skills/quickstart/SKILL.md +113 -0
- package/adapters/claude/skills/scenario-script/author/references/compose.md +43 -0
- package/adapters/claude/skills/scenario-script/author/references/inspect.md +105 -0
- package/adapters/claude/skills/scenario-script/author/references/validate.md +72 -0
- package/adapters/claude/skills/scenario-script/review/references/compose.md +43 -0
- package/adapters/claude/skills/scenario-script/review/references/inspect.md +105 -0
- package/adapters/claude/skills/scenario-script/review/references/validate.md +72 -0
- package/adapters/claude/skills/setup/SKILL.md +118 -0
- package/adapters/claude/skills/where-am-i/SKILL.md +1 -1
- package/adapters/codex/.codex-plugin/plugin.json +3 -12
- package/adapters/codex/EXTENDED-ARTIFACT-CATALOG.md +3 -0
- package/adapters/codex/EXTENDED-ARTIFACT-CATALOG.zh-CN.md +3 -0
- package/adapters/codex/INSTALL.md +33 -16
- package/adapters/codex/agent-methods/catalog.yaml +40 -4
- package/adapters/codex/compatibility.json +4 -4
- package/adapters/codex/scripts/lib/compatibility-policy.mjs +0 -65
- package/adapters/codex/skills/artifact-chain-bootstrap/SKILL.md +1 -1
- package/adapters/codex/skills/artifact-chain-maintainer/SKILL.md +1 -1
- package/adapters/codex/skills/artifact-review/SKILL.md +1 -1
- package/adapters/codex/skills/help/SKILL.md +96 -0
- package/adapters/codex/skills/prd-feature/author/references/compose.md +43 -0
- package/adapters/codex/skills/prd-feature/author/references/inspect.md +94 -0
- package/adapters/codex/skills/prd-feature/author/references/validate.md +65 -0
- package/adapters/codex/skills/prd-feature/review/references/compose.md +43 -0
- package/adapters/codex/skills/prd-feature/review/references/inspect.md +94 -0
- package/adapters/codex/skills/prd-feature/review/references/validate.md +65 -0
- package/adapters/codex/skills/quickstart/SKILL.md +113 -0
- package/adapters/codex/skills/scenario-script/author/references/compose.md +43 -0
- package/adapters/codex/skills/scenario-script/author/references/inspect.md +105 -0
- package/adapters/codex/skills/scenario-script/author/references/validate.md +72 -0
- package/adapters/codex/skills/scenario-script/review/references/compose.md +43 -0
- package/adapters/codex/skills/scenario-script/review/references/inspect.md +105 -0
- package/adapters/codex/skills/scenario-script/review/references/validate.md +72 -0
- package/adapters/codex/skills/setup/SKILL.md +118 -0
- package/adapters/codex/skills/where-am-i/SKILL.md +1 -1
- package/agent-methods/catalog.yaml +40 -4
- package/compatibility.json +4 -4
- package/package.json +5 -3
- package/scripts/build-adapters.mjs +22 -20
- package/scripts/check-method-registry.mjs +8 -5
- package/scripts/lib/compatibility-policy.mjs +0 -65
- package/scripts/sync-skills.mjs +169 -1
- package/skills/artifact-audit/SKILL.md +80 -0
- package/skills/artifact-batch/SKILL.md +115 -0
- package/skills/artifact-chain-bootstrap/SKILL.md +343 -0
- package/skills/artifact-chain-maintainer/SKILL.md +167 -0
- package/skills/artifact-generate/SKILL.md +89 -0
- package/skills/artifact-repair/SKILL.md +124 -0
- package/skills/artifact-review/SKILL.md +122 -0
- package/skills/artifact-workflow-worker/SKILL.md +90 -0
- package/skills/help/SKILL.md +96 -0
- package/skills/prd-feature/SKILL.md +68 -0
- package/skills/prd-feature/author/SKILL.md +92 -0
- package/skills/prd-feature/author/references/compose.md +43 -0
- package/skills/prd-feature/author/references/inspect.md +94 -0
- package/skills/prd-feature/author/references/validate.md +65 -0
- package/skills/prd-feature/references/compose.md +43 -0
- package/skills/prd-feature/references/inspect.md +94 -0
- package/skills/prd-feature/references/validate.md +65 -0
- package/skills/prd-feature/repair/SKILL.md +135 -0
- package/skills/prd-feature/review/SKILL.md +134 -0
- package/skills/prd-feature/review/references/compose.md +43 -0
- package/skills/prd-feature/review/references/inspect.md +94 -0
- package/skills/prd-feature/review/references/validate.md +65 -0
- package/skills/quickstart/SKILL.md +113 -0
- package/skills/scenario-script/SKILL.md +76 -0
- package/skills/scenario-script/author/SKILL.md +111 -0
- package/skills/scenario-script/author/references/compose.md +43 -0
- package/skills/scenario-script/author/references/inspect.md +105 -0
- package/skills/scenario-script/author/references/validate.md +72 -0
- package/skills/scenario-script/references/compose.md +43 -0
- package/skills/scenario-script/references/inspect.md +105 -0
- package/skills/scenario-script/references/validate.md +72 -0
- package/skills/scenario-script/repair/SKILL.md +135 -0
- package/skills/scenario-script/review/SKILL.md +137 -0
- package/skills/scenario-script/review/references/compose.md +43 -0
- package/skills/scenario-script/review/references/inspect.md +105 -0
- package/skills/scenario-script/review/references/validate.md +72 -0
- package/skills/setup/SKILL.md +118 -0
- package/skills/where-am-i/SKILL.md +233 -0
- package/skills-src/artifact-chain-bootstrap/SKILL.md +1 -1
- package/skills-src/artifact-chain-maintainer/SKILL.md +1 -1
- package/skills-src/artifact-review/SKILL.md +1 -1
- package/skills-src/help/SKILL.md +96 -0
- package/skills-src/quickstart/SKILL.md +113 -0
- package/skills-src/setup/SKILL.md +118 -0
- package/skills-src/where-am-i/SKILL.md.tpl +1 -1
- package/templates/claude/plugin.json.tpl +17 -2
- package/templates/codex/plugin.json.tpl +2 -11
- package/.agents/plugins/marketplace.json +0 -20
- package/.claude-plugin/marketplace.json +0 -20
- package/templates/claude/marketplace.json.tpl +0 -20
- package/templates/codex/marketplace.json.tpl +0 -20
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: help
|
|
3
|
+
description: 展示 artifact-chain-assistant 插件的标准 Family API、bundled legacy 方法和安装后采用步骤。安装后即使专业 family 实现未安装,用户也能看见标准能力。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# help
|
|
7
|
+
|
|
8
|
+
## 目的
|
|
9
|
+
|
|
10
|
+
轻量展示 artifact-chain 生态的可用标准能力,帮助用户了解安装后可以使用哪些技能族和服务。本技能只做安全渲染,不做项目生命周期判断。
|
|
11
|
+
|
|
12
|
+
## 职责边界
|
|
13
|
+
|
|
14
|
+
- **渲染静态 Family API Catalog**:从 `family-apis/catalog.json` 读取标准 family 和 service 定义,即使实现未安装也可见。
|
|
15
|
+
- **展示 bundled legacy 方法**:从 `families-src/*/implementation.yaml` 读取已有的 bundled family 迁移样本,诚实标记 `targetApiStatus: pending`。
|
|
16
|
+
- **动态 projection 当前 fail-closed**:Registry v2 verifier 尚未接入时,无论是否提供 projection 都只显示 `NOT_AVAILABLE / REGISTRY_V2_REQUIRED`。
|
|
17
|
+
- **不读取第三方 `SKILL.md`**:不解析项目 sources/bindings,不自行计算 provider 状态。
|
|
18
|
+
- **不猜测安装/启用/信任状态**:没有 projection 时不输出 `NOT_INSTALLED` 或 `ENABLED`。
|
|
19
|
+
|
|
20
|
+
## 渲染内容
|
|
21
|
+
|
|
22
|
+
### 1. Standard Family API
|
|
23
|
+
|
|
24
|
+
从 Family API Catalog 渲染所有已发布的标准 family:
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
## Standard Family API
|
|
28
|
+
|
|
29
|
+
| Family | Major | Services | Summary |
|
|
30
|
+
|--------|-------|----------|---------|
|
|
31
|
+
| artifact.e2e-test-family | 1 | default, help, author, review, repair | E2E Test Skill Family |
|
|
32
|
+
|
|
33
|
+
### artifact.e2e-test-family@1
|
|
34
|
+
|
|
35
|
+
Standard skill family for authoring, reviewing, and repairing E2E test specification artifacts.
|
|
36
|
+
|
|
37
|
+
**Services:**
|
|
38
|
+
- `default` (required, workflow) — Default route entry
|
|
39
|
+
- `help` (required, operation) — Help and capability overview
|
|
40
|
+
- `author` (required, workflow) — Author E2E test specs from feature/scenario artifacts
|
|
41
|
+
- `review` (required, operation) — Review E2E test specifications
|
|
42
|
+
- `repair` (required, workflow) — Repair E2E test specs based on review findings
|
|
43
|
+
|
|
44
|
+
**Artifact Contracts:** artifact.e2e-test@1;feature/scenario 输入仍以版本化 protocol ref 表达
|
|
45
|
+
**Side-effect ceiling:** write-authorized-artifacts (author/repair), write-review-result (review)
|
|
46
|
+
**Mix-safe:** No (default whole-family atomic binding)
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### 2. Bundled Legacy Methods
|
|
50
|
+
|
|
51
|
+
从 `families-src/*/implementation.yaml` 渲染现有 bundled family:
|
|
52
|
+
|
|
53
|
+
```
|
|
54
|
+
## Bundled Legacy Methods
|
|
55
|
+
|
|
56
|
+
These bundled families predate the standard Family API system.
|
|
57
|
+
They are recorded as migration samples and will be migrated to formal Family API conformance.
|
|
58
|
+
|
|
59
|
+
### prd-feature (bundled-stable)
|
|
60
|
+
- Status: targetApiStatus: pending (no published Family API)
|
|
61
|
+
- Services: default, author, review, repair
|
|
62
|
+
- Note: Does NOT claim Family API conformance
|
|
63
|
+
|
|
64
|
+
### scenario-script (bundled-stable)
|
|
65
|
+
- Status: targetApiStatus: pending (no published Family API)
|
|
66
|
+
- Services: default, author, review, repair
|
|
67
|
+
- Note: Does NOT claim Family API conformance
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### 3. Installation Status
|
|
71
|
+
|
|
72
|
+
```
|
|
73
|
+
## Installation Status
|
|
74
|
+
|
|
75
|
+
Registry projection: NOT_AVAILABLE (REGISTRY_V2_REQUIRED)
|
|
76
|
+
(Dynamic state is unavailable until the authoritative Registry v2 verifier is integrated.)
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
即使 projection 文件自称已校验,也不得由 assistant 直接渲染。后续只能消费 Registry v2 verifier 的权威结果。
|
|
80
|
+
|
|
81
|
+
## 采用步骤
|
|
82
|
+
|
|
83
|
+
```
|
|
84
|
+
## Getting Started
|
|
85
|
+
|
|
86
|
+
1. **Learn**: Review the Standard Family API above to understand available capabilities.
|
|
87
|
+
2. **Bootstrap**: Run `artifact-chain-bootstrap` (with user authorization) to set up your project.
|
|
88
|
+
3. **Orient**: Run `where-am-i` to get project-specific recommendations based on your current state.
|
|
89
|
+
4. **Adopt**: Follow where-am-i recommendations to adopt specific families and services.
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
## 故障诊断
|
|
93
|
+
|
|
94
|
+
- 如果 Family API Catalog 缺失或格式错误:检查 `family-apis/catalog.json` 是否存在于插件安装目录。
|
|
95
|
+
- 如果 bundled 方法不显示:检查 `families-src/*/implementation.yaml` 是否存在。
|
|
96
|
+
- 如果 registry 状态为 `NOT_AVAILABLE / REGISTRY_V2_REQUIRED`:等待或安装提供权威 projection verifier 的 Registry v2;不要信任手写状态文件。
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# prd-feature compose
|
|
2
|
+
|
|
3
|
+
内部工序,不作为 catalog 入口。
|
|
4
|
+
|
|
5
|
+
## 目的
|
|
6
|
+
|
|
7
|
+
基于 inspect 结果编写 PRD 功能特性制品的 frontmatter 和正文。
|
|
8
|
+
|
|
9
|
+
## 步骤
|
|
10
|
+
|
|
11
|
+
### 1. 确定制品 ID
|
|
12
|
+
|
|
13
|
+
- 从项目中 PRD 注册类型对应的 `idPatterns` 派生合法 ID;未配置时沿用项目同类制品约定
|
|
14
|
+
- 检查与已有制品 ID 不冲突
|
|
15
|
+
- ID 风格与同类制品保持一致
|
|
16
|
+
|
|
17
|
+
### 2. 编写 frontmatter
|
|
18
|
+
|
|
19
|
+
字段、状态初值和关联字段从项目模板、配置及同类制品派生。不要自行增加项目未采用的字段或状态。
|
|
20
|
+
|
|
21
|
+
### 3. 编写正文结构
|
|
22
|
+
|
|
23
|
+
优先遵循项目模板。模板未规定时,组织业务目标、可验证验收标准、关键约束和关联证据;章节名称不作固定要求。
|
|
24
|
+
|
|
25
|
+
### 4. 验收标准编写规则
|
|
26
|
+
|
|
27
|
+
每条验收标准必须:
|
|
28
|
+
- 使用编号列表
|
|
29
|
+
- 以动词开头("支持""提供""确保""验证")
|
|
30
|
+
- 包含可验证的条件(不使用"足够""合理""尽快"等模糊词)
|
|
31
|
+
- 可映射到至少一个测试场景或实现验证点
|
|
32
|
+
|
|
33
|
+
### 5. 文件放置
|
|
34
|
+
|
|
35
|
+
- 文件名:`<id>.md` 或 `<id>-<slug>.md`
|
|
36
|
+
- 路径:按项目中 PRD 注册类型的 paths 配置
|
|
37
|
+
- 文件名与 ID 保持可追溯对应
|
|
38
|
+
|
|
39
|
+
## 输出
|
|
40
|
+
|
|
41
|
+
compose 输出供 validate 和 review 消费:
|
|
42
|
+
- 完整的制品文件内容
|
|
43
|
+
- 制品 ID 和路径
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
# prd-feature inspect
|
|
2
|
+
|
|
3
|
+
内部工序,不作为 catalog 入口。
|
|
4
|
+
|
|
5
|
+
## 目的
|
|
6
|
+
|
|
7
|
+
在编写或审阅 PRD 功能特性制品前,收集项目配置、已有制品、关联关系和实现状态的证据。
|
|
8
|
+
|
|
9
|
+
## 步骤
|
|
10
|
+
|
|
11
|
+
### 1. 项目配置发现
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
# 确认项目根目录
|
|
15
|
+
git rev-parse --show-toplevel
|
|
16
|
+
|
|
17
|
+
# 读取 artifact-graph 配置
|
|
18
|
+
cat artifact-graph.config.yaml
|
|
19
|
+
|
|
20
|
+
# 确认 CLI 能力
|
|
21
|
+
artifact-graph --help
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
提取:
|
|
25
|
+
- PRD 对应的注册类型名、paths、target 与对应 `idPatterns`(如有)
|
|
26
|
+
- 项目模板、`artifacts/README.md`、`AGENTS.md`/`CLAUDE.md` 中的本地规则
|
|
27
|
+
- 项目注册的关联类型与同类制品实际使用的关联字段
|
|
28
|
+
|
|
29
|
+
### 2. 已有制品扫描
|
|
30
|
+
|
|
31
|
+
从步骤 1 提取的 PRD 注册类型 paths 扫描已有制品:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
# 查询特定制品关系
|
|
35
|
+
artifact-graph query --from <ID>
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
记录:
|
|
39
|
+
- 已有制品 ID 列表(用于 ID 唯一性检查)
|
|
40
|
+
- 已有制品 status 分布
|
|
41
|
+
- 制品文件命名模式
|
|
42
|
+
|
|
43
|
+
### 3. 关联制品可达性
|
|
44
|
+
|
|
45
|
+
对项目配置、模板或同类制品声明的每个关联 ID:
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
artifact-graph query --from <RELATED_ID>
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
记录每个关联 ID 的存在状态;状态取值沿用目标项目的表达。
|
|
52
|
+
|
|
53
|
+
### 4. 实现状态检查
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
artifact-graph context --target <type>:<ID> --mode implementation
|
|
57
|
+
artifact-graph validate --root . --warning-only
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
记录:
|
|
61
|
+
- 实现文件列表
|
|
62
|
+
- validate 警告列表
|
|
63
|
+
- 追溯注释存在性
|
|
64
|
+
|
|
65
|
+
## 输出
|
|
66
|
+
|
|
67
|
+
inspect 输出供 author、review、repair 流程消费:
|
|
68
|
+
|
|
69
|
+
```yaml
|
|
70
|
+
project:
|
|
71
|
+
root: <项目根目录>
|
|
72
|
+
config_loaded: true | false
|
|
73
|
+
artifact_type:
|
|
74
|
+
name: <项目注册的 PRD 类型名>
|
|
75
|
+
registered: true | false
|
|
76
|
+
paths: [<制品路径列表>]
|
|
77
|
+
id_pattern: <ID pattern>
|
|
78
|
+
existing_artifacts:
|
|
79
|
+
- id: <ID>
|
|
80
|
+
path: <文件路径>
|
|
81
|
+
status: <status>
|
|
82
|
+
target_artifact:
|
|
83
|
+
id: <ID> | null
|
|
84
|
+
path: <文件路径> | null
|
|
85
|
+
exists: true | false
|
|
86
|
+
related:
|
|
87
|
+
artifacts: [{ type, id, status }]
|
|
88
|
+
validation:
|
|
89
|
+
warnings: [<警告列表>]
|
|
90
|
+
pass: true | false
|
|
91
|
+
implementation:
|
|
92
|
+
files: [<实现文件列表>]
|
|
93
|
+
trace_comments: [<追溯注释列表>]
|
|
94
|
+
```
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# prd-feature validate
|
|
2
|
+
|
|
3
|
+
内部工序,不作为 catalog 入口。
|
|
4
|
+
|
|
5
|
+
## 目的
|
|
6
|
+
|
|
7
|
+
在 author 或 repair 完成后,验证 PRD 功能特性制品的结构完整性和制品链一致性。
|
|
8
|
+
|
|
9
|
+
## 步骤
|
|
10
|
+
|
|
11
|
+
### 1. 制品链验证
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
artifact-graph validate --root . --warning-only
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
检查:
|
|
18
|
+
- 无新增孤立制品警告
|
|
19
|
+
- 无新增关联引用警告
|
|
20
|
+
- 新制品已正确参与图遍历
|
|
21
|
+
|
|
22
|
+
### 2. 项目规范完整性
|
|
23
|
+
|
|
24
|
+
按项目配置、模板、`artifacts/README.md` 和同类制品检查 frontmatter、ID、状态与正文结构;不要假设固定字段或枚举。
|
|
25
|
+
|
|
26
|
+
### 3. ID 唯一性
|
|
27
|
+
|
|
28
|
+
从 `artifact-graph.config.yaml` 中 PRD 注册类型的 paths 派生扫描路径,确认新制品 ID 不与已有制品冲突。
|
|
29
|
+
|
|
30
|
+
### 4. 关联可达性
|
|
31
|
+
|
|
32
|
+
对项目规则声明的关联字段中的每个 ID:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
artifact-graph query --from <ID>
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
确认关联制品在图中存在。
|
|
39
|
+
|
|
40
|
+
### 5. 验收标准基本检查
|
|
41
|
+
|
|
42
|
+
- 能定位非空的验收标准(章节名服从项目模板)
|
|
43
|
+
- 标准有编号
|
|
44
|
+
- 未决事项与项目状态规则不冲突
|
|
45
|
+
|
|
46
|
+
## 输出
|
|
47
|
+
|
|
48
|
+
validate 输出供 review 和 repair 消费:
|
|
49
|
+
|
|
50
|
+
```yaml
|
|
51
|
+
validation:
|
|
52
|
+
artifact_id: <ID>
|
|
53
|
+
artifact_path: <文件路径>
|
|
54
|
+
issues:
|
|
55
|
+
- code: <问题代码>
|
|
56
|
+
severity: error | warning | info
|
|
57
|
+
message: <问题描述>
|
|
58
|
+
location: <文件路径>:<行号>
|
|
59
|
+
pass: true | false
|
|
60
|
+
chain_check:
|
|
61
|
+
validate_output: <artifact-graph validate 关键输出>
|
|
62
|
+
related_check:
|
|
63
|
+
- id: <关联 ID>
|
|
64
|
+
exists: true | false
|
|
65
|
+
```
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# prd-feature compose
|
|
2
|
+
|
|
3
|
+
内部工序,不作为 catalog 入口。
|
|
4
|
+
|
|
5
|
+
## 目的
|
|
6
|
+
|
|
7
|
+
基于 inspect 结果编写 PRD 功能特性制品的 frontmatter 和正文。
|
|
8
|
+
|
|
9
|
+
## 步骤
|
|
10
|
+
|
|
11
|
+
### 1. 确定制品 ID
|
|
12
|
+
|
|
13
|
+
- 从项目中 PRD 注册类型对应的 `idPatterns` 派生合法 ID;未配置时沿用项目同类制品约定
|
|
14
|
+
- 检查与已有制品 ID 不冲突
|
|
15
|
+
- ID 风格与同类制品保持一致
|
|
16
|
+
|
|
17
|
+
### 2. 编写 frontmatter
|
|
18
|
+
|
|
19
|
+
字段、状态初值和关联字段从项目模板、配置及同类制品派生。不要自行增加项目未采用的字段或状态。
|
|
20
|
+
|
|
21
|
+
### 3. 编写正文结构
|
|
22
|
+
|
|
23
|
+
优先遵循项目模板。模板未规定时,组织业务目标、可验证验收标准、关键约束和关联证据;章节名称不作固定要求。
|
|
24
|
+
|
|
25
|
+
### 4. 验收标准编写规则
|
|
26
|
+
|
|
27
|
+
每条验收标准必须:
|
|
28
|
+
- 使用编号列表
|
|
29
|
+
- 以动词开头("支持""提供""确保""验证")
|
|
30
|
+
- 包含可验证的条件(不使用"足够""合理""尽快"等模糊词)
|
|
31
|
+
- 可映射到至少一个测试场景或实现验证点
|
|
32
|
+
|
|
33
|
+
### 5. 文件放置
|
|
34
|
+
|
|
35
|
+
- 文件名:`<id>.md` 或 `<id>-<slug>.md`
|
|
36
|
+
- 路径:按项目中 PRD 注册类型的 paths 配置
|
|
37
|
+
- 文件名与 ID 保持可追溯对应
|
|
38
|
+
|
|
39
|
+
## 输出
|
|
40
|
+
|
|
41
|
+
compose 输出供 validate 和 review 消费:
|
|
42
|
+
- 完整的制品文件内容
|
|
43
|
+
- 制品 ID 和路径
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
# prd-feature inspect
|
|
2
|
+
|
|
3
|
+
内部工序,不作为 catalog 入口。
|
|
4
|
+
|
|
5
|
+
## 目的
|
|
6
|
+
|
|
7
|
+
在编写或审阅 PRD 功能特性制品前,收集项目配置、已有制品、关联关系和实现状态的证据。
|
|
8
|
+
|
|
9
|
+
## 步骤
|
|
10
|
+
|
|
11
|
+
### 1. 项目配置发现
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
# 确认项目根目录
|
|
15
|
+
git rev-parse --show-toplevel
|
|
16
|
+
|
|
17
|
+
# 读取 artifact-graph 配置
|
|
18
|
+
cat artifact-graph.config.yaml
|
|
19
|
+
|
|
20
|
+
# 确认 CLI 能力
|
|
21
|
+
artifact-graph --help
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
提取:
|
|
25
|
+
- PRD 对应的注册类型名、paths、target 与对应 `idPatterns`(如有)
|
|
26
|
+
- 项目模板、`artifacts/README.md`、`AGENTS.md`/`CLAUDE.md` 中的本地规则
|
|
27
|
+
- 项目注册的关联类型与同类制品实际使用的关联字段
|
|
28
|
+
|
|
29
|
+
### 2. 已有制品扫描
|
|
30
|
+
|
|
31
|
+
从步骤 1 提取的 PRD 注册类型 paths 扫描已有制品:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
# 查询特定制品关系
|
|
35
|
+
artifact-graph query --from <ID>
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
记录:
|
|
39
|
+
- 已有制品 ID 列表(用于 ID 唯一性检查)
|
|
40
|
+
- 已有制品 status 分布
|
|
41
|
+
- 制品文件命名模式
|
|
42
|
+
|
|
43
|
+
### 3. 关联制品可达性
|
|
44
|
+
|
|
45
|
+
对项目配置、模板或同类制品声明的每个关联 ID:
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
artifact-graph query --from <RELATED_ID>
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
记录每个关联 ID 的存在状态;状态取值沿用目标项目的表达。
|
|
52
|
+
|
|
53
|
+
### 4. 实现状态检查
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
artifact-graph context --target <type>:<ID> --mode implementation
|
|
57
|
+
artifact-graph validate --root . --warning-only
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
记录:
|
|
61
|
+
- 实现文件列表
|
|
62
|
+
- validate 警告列表
|
|
63
|
+
- 追溯注释存在性
|
|
64
|
+
|
|
65
|
+
## 输出
|
|
66
|
+
|
|
67
|
+
inspect 输出供 author、review、repair 流程消费:
|
|
68
|
+
|
|
69
|
+
```yaml
|
|
70
|
+
project:
|
|
71
|
+
root: <项目根目录>
|
|
72
|
+
config_loaded: true | false
|
|
73
|
+
artifact_type:
|
|
74
|
+
name: <项目注册的 PRD 类型名>
|
|
75
|
+
registered: true | false
|
|
76
|
+
paths: [<制品路径列表>]
|
|
77
|
+
id_pattern: <ID pattern>
|
|
78
|
+
existing_artifacts:
|
|
79
|
+
- id: <ID>
|
|
80
|
+
path: <文件路径>
|
|
81
|
+
status: <status>
|
|
82
|
+
target_artifact:
|
|
83
|
+
id: <ID> | null
|
|
84
|
+
path: <文件路径> | null
|
|
85
|
+
exists: true | false
|
|
86
|
+
related:
|
|
87
|
+
artifacts: [{ type, id, status }]
|
|
88
|
+
validation:
|
|
89
|
+
warnings: [<警告列表>]
|
|
90
|
+
pass: true | false
|
|
91
|
+
implementation:
|
|
92
|
+
files: [<实现文件列表>]
|
|
93
|
+
trace_comments: [<追溯注释列表>]
|
|
94
|
+
```
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# prd-feature validate
|
|
2
|
+
|
|
3
|
+
内部工序,不作为 catalog 入口。
|
|
4
|
+
|
|
5
|
+
## 目的
|
|
6
|
+
|
|
7
|
+
在 author 或 repair 完成后,验证 PRD 功能特性制品的结构完整性和制品链一致性。
|
|
8
|
+
|
|
9
|
+
## 步骤
|
|
10
|
+
|
|
11
|
+
### 1. 制品链验证
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
artifact-graph validate --root . --warning-only
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
检查:
|
|
18
|
+
- 无新增孤立制品警告
|
|
19
|
+
- 无新增关联引用警告
|
|
20
|
+
- 新制品已正确参与图遍历
|
|
21
|
+
|
|
22
|
+
### 2. 项目规范完整性
|
|
23
|
+
|
|
24
|
+
按项目配置、模板、`artifacts/README.md` 和同类制品检查 frontmatter、ID、状态与正文结构;不要假设固定字段或枚举。
|
|
25
|
+
|
|
26
|
+
### 3. ID 唯一性
|
|
27
|
+
|
|
28
|
+
从 `artifact-graph.config.yaml` 中 PRD 注册类型的 paths 派生扫描路径,确认新制品 ID 不与已有制品冲突。
|
|
29
|
+
|
|
30
|
+
### 4. 关联可达性
|
|
31
|
+
|
|
32
|
+
对项目规则声明的关联字段中的每个 ID:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
artifact-graph query --from <ID>
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
确认关联制品在图中存在。
|
|
39
|
+
|
|
40
|
+
### 5. 验收标准基本检查
|
|
41
|
+
|
|
42
|
+
- 能定位非空的验收标准(章节名服从项目模板)
|
|
43
|
+
- 标准有编号
|
|
44
|
+
- 未决事项与项目状态规则不冲突
|
|
45
|
+
|
|
46
|
+
## 输出
|
|
47
|
+
|
|
48
|
+
validate 输出供 review 和 repair 消费:
|
|
49
|
+
|
|
50
|
+
```yaml
|
|
51
|
+
validation:
|
|
52
|
+
artifact_id: <ID>
|
|
53
|
+
artifact_path: <文件路径>
|
|
54
|
+
issues:
|
|
55
|
+
- code: <问题代码>
|
|
56
|
+
severity: error | warning | info
|
|
57
|
+
message: <问题描述>
|
|
58
|
+
location: <文件路径>:<行号>
|
|
59
|
+
pass: true | false
|
|
60
|
+
chain_check:
|
|
61
|
+
validate_output: <artifact-graph validate 关键输出>
|
|
62
|
+
related_check:
|
|
63
|
+
- id: <关联 ID>
|
|
64
|
+
exists: true | false
|
|
65
|
+
```
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: quickstart
|
|
3
|
+
description: 按意图路由到正确的技能。根据用户描述的意图,推荐最合适的入口技能和最小调用提示词。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# quickstart
|
|
7
|
+
|
|
8
|
+
## 目的
|
|
9
|
+
|
|
10
|
+
为首次使用 artifact-chain-assistant 或不确定该用哪个技能的用户提供单一入口。根据用户描述的意图进行自然语言路由,输出目标技能名称、推荐理由和最小调用提示词。
|
|
11
|
+
|
|
12
|
+
## 职责边界
|
|
13
|
+
|
|
14
|
+
- **纯路由**:不执行任何写操作或项目分析。
|
|
15
|
+
- **不复制技能逻辑**:quickstart 只做意图判断和路由推荐,不执行被路由技能的任何步骤。
|
|
16
|
+
- **不猜测意图**:当用户意图不明确时,输出追问而非猜测路由。
|
|
17
|
+
|
|
18
|
+
## 路由规则
|
|
19
|
+
|
|
20
|
+
根据用户输入的意图,按以下规则路由:
|
|
21
|
+
|
|
22
|
+
### 能力说明或功能查询
|
|
23
|
+
|
|
24
|
+
**匹配关键词**:能做什么、功能、能力、what can、help、capabilities
|
|
25
|
+
|
|
26
|
+
**路由目标**:`help`
|
|
27
|
+
|
|
28
|
+
**理由**:help 技能展示标准 Family API Catalog、bundled legacy 方法和采用步骤。
|
|
29
|
+
|
|
30
|
+
**最小提示词**:`请展示 artifact-chain-assistant 的标准能力和采用步骤。`
|
|
31
|
+
|
|
32
|
+
### 环境检查或采用状态确认
|
|
33
|
+
|
|
34
|
+
**匹配关键词**:环境、检查、准备好了吗、状态、setup、ready
|
|
35
|
+
|
|
36
|
+
**路由目标**:`setup`
|
|
37
|
+
|
|
38
|
+
**理由**:setup 技能执行只读环境检查并输出结构化状态报告。
|
|
39
|
+
|
|
40
|
+
**最小提示词**:`请检查我的环境是否具备使用 artifact-chain-assistant 的条件。`
|
|
41
|
+
|
|
42
|
+
### 首次初始化或结构修复
|
|
43
|
+
|
|
44
|
+
**匹配关键词**:初始化、初始化项目、bootstrap、设置、configure、init、修复配置
|
|
45
|
+
|
|
46
|
+
**路由目标**:先 `setup`,经用户授权后进入 `artifact-chain-bootstrap`
|
|
47
|
+
|
|
48
|
+
**理由**:先通过 setup 了解当前状态,再由用户决定是否授权 bootstrap 执行写入操作。
|
|
49
|
+
|
|
50
|
+
**最小提示词**:`请先检查我的环境状态,然后引导我完成项目初始化。`
|
|
51
|
+
|
|
52
|
+
### 模糊的项目需求或制品定位
|
|
53
|
+
|
|
54
|
+
**匹配关键词**:该做什么、下一步、当前状态、制品在哪、where、定位
|
|
55
|
+
|
|
56
|
+
**路由目标**:`where-am-i`
|
|
57
|
+
|
|
58
|
+
**理由**:where-am-i 搜索项目配置和制品图,输出结构化的项目事实和路由建议。
|
|
59
|
+
|
|
60
|
+
**最小提示词**:`请分析我的项目当前状态并推荐下一步。`
|
|
61
|
+
|
|
62
|
+
### 日常维护、版本锁刷新或 hook 管理
|
|
63
|
+
|
|
64
|
+
**匹配关键词**:维护、刷新锁、version-lock、hook、maintain、update
|
|
65
|
+
|
|
66
|
+
**路由目标**:`artifact-chain-maintainer`
|
|
67
|
+
|
|
68
|
+
**理由**:maintainer 技能处理日常维护任务,包括版本锁刷新和 hook 管理。
|
|
69
|
+
|
|
70
|
+
**最小提示词**:`请帮我执行日常维护任务。`
|
|
71
|
+
|
|
72
|
+
### 明确的制品制作/审阅/修复任务
|
|
73
|
+
|
|
74
|
+
**匹配关键词**:制作、审阅、修复、author、review、repair、PRD、scenario、design
|
|
75
|
+
|
|
76
|
+
**路由目标**:对应的 family/service
|
|
77
|
+
|
|
78
|
+
**理由**:用户已明确知道要执行的操作,直接路由到对应的专业入口。
|
|
79
|
+
|
|
80
|
+
**最小提示词**:根据具体任务构造,例如 `请审阅这个 PRD feature 制品。`
|
|
81
|
+
|
|
82
|
+
### 意图不明确
|
|
83
|
+
|
|
84
|
+
**行为**:输出追问,不猜测路由。
|
|
85
|
+
|
|
86
|
+
**追问示例**:
|
|
87
|
+
```
|
|
88
|
+
您的意图不太明确,请告诉我更多信息:
|
|
89
|
+
- 您想了解这个插件能做什么?→ 我会路由到 help
|
|
90
|
+
- 您想检查环境是否准备就绪?→ 我会路由到 setup
|
|
91
|
+
- 您想初始化项目?→ 我会先检查环境,再引导 bootstrap
|
|
92
|
+
- 您想知道下一步该做什么?→ 我会路由到 where-am-i
|
|
93
|
+
- 您有明确的制品任务?→ 请描述具体操作(制作/审阅/修复)和制品类型
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
## 输出格式
|
|
97
|
+
|
|
98
|
+
```
|
|
99
|
+
## 路由建议
|
|
100
|
+
|
|
101
|
+
**目标技能**:`help`
|
|
102
|
+
**推荐理由**:您询问的是插件能力,help 技能展示标准 Family API 和采用步骤。
|
|
103
|
+
**最小提示词**:`请展示 artifact-chain-assistant 的标准能力和采用步骤。`
|
|
104
|
+
|
|
105
|
+
> 直接将最小提示词发送给助手即可启动目标技能。
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
## 安全边界
|
|
109
|
+
|
|
110
|
+
- quickstart 本身不执行任何写操作或项目分析。
|
|
111
|
+
- 路由推荐基于用户意图的自然语言匹配,不依赖项目状态。
|
|
112
|
+
- 当意图匹配多个技能时,输出候选列表和区分标准,由用户选择。
|
|
113
|
+
- 当意图超出插件能力范围时,明确说明并建议外部资源。
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# scenario-script compose
|
|
2
|
+
|
|
3
|
+
内部工序,不作为 catalog 入口。
|
|
4
|
+
|
|
5
|
+
## 目的
|
|
6
|
+
|
|
7
|
+
基于 inspect 结果编写场景剧本制品的 frontmatter 和正文。
|
|
8
|
+
|
|
9
|
+
## 步骤
|
|
10
|
+
|
|
11
|
+
### 1. 确定制品 ID
|
|
12
|
+
|
|
13
|
+
- 从项目 `idPatterns` 中场景类型对应的 pattern 派生合法 ID
|
|
14
|
+
- 检查与已有制品 ID 不冲突
|
|
15
|
+
- ID 应简短且具有业务语义
|
|
16
|
+
|
|
17
|
+
### 2. 编写 frontmatter
|
|
18
|
+
|
|
19
|
+
从 inspect 输出的项目模板、配置和同类制品派生 frontmatter。不得自行增加项目未采用的字段或状态。
|
|
20
|
+
|
|
21
|
+
### 3. 编写正文结构
|
|
22
|
+
|
|
23
|
+
正文应覆盖角色与目标、前置条件、主路径、异常路径、可观察结果和必要追溯等通用质量维度;具体章节名和布局从项目模板与已有制品派生。
|
|
24
|
+
|
|
25
|
+
### 4. 场景步骤编写规则
|
|
26
|
+
|
|
27
|
+
每个主路径和异常路径步骤必须:
|
|
28
|
+
- 使用编号列表
|
|
29
|
+
- 以动词开头
|
|
30
|
+
- 包含可验证的条件(不使用"足够""合理""尽快"等模糊词)
|
|
31
|
+
- 每个异常路径描述触发条件和预期处理方式
|
|
32
|
+
|
|
33
|
+
### 5. 文件放置
|
|
34
|
+
|
|
35
|
+
- 文件名按项目制品命名模式(从已有制品扫描结果派生)
|
|
36
|
+
- 路径按项目中场景剧本注册类型的 paths 配置
|
|
37
|
+
- 文件名与 ID 保持可追溯对应
|
|
38
|
+
|
|
39
|
+
## 输出
|
|
40
|
+
|
|
41
|
+
compose 输出供 validate 和 review 消费:
|
|
42
|
+
- 完整的制品文件内容
|
|
43
|
+
- 制品 ID 和路径
|