artifact-chain-assistant 0.8.0

package/templates/extended/agent/prompt_packet/starter.md

@@ -0,0 +1,106 @@
+---
+id: {PP_ID}
+title: {Prompt Packet 标题}
+status: draft
+related_features: []
+related_decisions: []
+---
+
+# {PP_ID}: {Prompt Packet 标题}
+
+<!-- 本模板是插件 starter 指导，项目本地模板可完全覆盖 -->
+<!-- 插件模板是入门指导，项目本地模板是权威 -->
+
+## 概述
+
+{描述这个 Prompt Packet 的用途：为哪个 AI 辅助任务组装上下文，解决什么问题}
+
+## 元信息
+
+- **名称**：{packet_name}
+- **描述**：{description}
+- **适用场景**：{使用场景}
+- **目标 Agent/工具**：{Claude Code / Codex / 其他}
+
+## 上下文组装
+
+### 必需上下文
+
+| 来源 | 类型 | 说明 |
+|------|------|------|
+| {source1} | {制品类型} | {为什么需要} |
+| {source2} | {制品类型} | {为什么需要} |
+
+### 可选上下文
+
+| 来源 | 类型 | 说明 |
+|------|------|------|
+| {source3} | {制品类型} | {增强效果} |
+
+## Prompt 模板
+
+### 系统提示
+
+```
+{系统提示内容}
+```
+
+### 用户提示
+
+```
+{用户提示内容}
+```
+
+### 上下文注入点
+
+| 占位符 | 来源 | 填充规则 |
+|--------|------|---------|
+| `{placeholder1}` | {source} | {规则} |
+| `{placeholder2}` | {source} | {规则} |
+
+## 输出契约
+
+### 期望输出格式
+
+```json
+{
+  "result": "期望输出结构"
+}
+```
+
+### 质量标准
+
+- {标准1}
+- {标准2}
+
+## 组装流程
+
+### 步骤 1：{步骤标题}
+
+**目的**：{步骤目的}
+
+**输入**：{输入}
+**处理**：{处理逻辑}
+**输出**：{输出}
+
+### 步骤 2：{步骤标题}
+
+{同上结构}
+
+## 使用约束
+
+- **Token 预算**：{预期 token 消耗范围}
+- **更新频率**：{多久需要重新组装}
+- **适用范围**：{不适用的情况}
+
+## 关联制品
+
+- 功能特性：{related_features}
+- 决策：{related_decisions}
+- Agent 技能：{关联的 agent_skill 制品}
+
+## 变更日志
+
+| 日期 | 变更 | 作者 |
+|------|------|------|
+| {YYYY-MM-DD} | 初始草稿 | {作者} |

package/templates/extended/contracts/api_contract/review-checklist.md

@@ -0,0 +1,43 @@
+# API Contract 审查清单
+
+<!-- 本清单是插件通用基线，项目本地审查规则可覆盖 -->
+
+## 结构完整性
+
+- [ ] `id` 字段存在且符合项目 ID 模式（如 `API-{nnn}` 或 `{service}-API-{version}`）
+- [ ] `title` 清晰描述 API 范围
+- [ ] `version` 字段存在且符合语义化版本
+- [ ] `status` 字段存在且为有效值
+
+## 接口质量
+
+- [ ] 每个端点有清晰描述
+- [ ] 请求参数类型和必填性明确
+- [ ] 响应格式完整且示例正确
+- [ ] 错误码覆盖常见异常场景
+
+## 数据模型
+
+- [ ] 数据模型定义完整
+- [ ] 字段类型和约束明确
+- [ ] 枚举值有文档说明
+- [ ] 嵌套关系清晰
+
+## 安全性
+
+- [ ] 认证方式已说明
+- [ ] 敏感字段已标记
+- [ ] 权限要求已记录
+- [ ] 速率限制已说明（如适用）
+
+## 追溯性
+
+- [ ] 关联功能特性存在
+- [ ] API 可追溯到业务需求
+- [ ] 版本变更可追溯
+
+## 实现一致性
+
+- [ ] 与实现代码一致
+- [ ] 文档与实际行为匹配
+- [ ] 测试覆盖所有端点

package/templates/extended/contracts/api_contract/starter.md

@@ -0,0 +1,92 @@
+---
+id: {API_ID}
+title: {API 名称}
+status: draft
+version: {v1}
+base_url: {基础 URL}
+related_features: []
+---
+
+# {API_ID}: {API 名称}
+
+<!-- 本模板是插件 starter 指导，项目本地模板可完全覆盖 -->
+<!-- 插件模板是入门指导，项目本地模板是权威 -->
+
+## 概述
+
+{描述这个 API 的用途、范围和主要能力}
+
+## 基础信息
+
+- **版本**：{version}
+- **Base URL**：{base_url}
+- **协议**：REST / GraphQL / gRPC
+- **认证方式**：{认证方式}
+
+## 端点列表
+
+### {METHOD} {路径}
+
+**描述**：{端点描述}
+
+**请求参数**：
+
+| 参数 | 类型 | 必填 | 描述 |
+|------|------|------|------|
+| {param} | {type} | {yes/no} | {描述} |
+
+**请求体**（如适用）：
+
+```json
+{
+  "field1": "type",
+  "field2": "type"
+}
+```
+
+**响应**：
+
+```json
+{
+  "success": true,
+  "data": {
+    "field1": "value"
+  }
+}
+```
+
+**错误码**：
+
+| 状态码 | 错误码 | 描述 |
+|--------|--------|------|
+| 400 | INVALID_PARAM | 参数无效 |
+| 401 | UNAUTHORIZED | 未认证 |
+| 404 | NOT_FOUND | 资源不存在 |
+
+## 数据模型
+
+### {Model Name}
+
+```json
+{
+  "id": "string",
+  "name": "string",
+  "created_at": "datetime"
+}
+```
+
+## 版本兼容性
+
+{描述版本兼容策略和破坏性变更规则}
+
+## 关联制品
+
+- 功能特性：{related_features}
+- 设计文档：{related_designs}
+- 决策：{related_decisions}
+
+## 变更日志
+
+| 日期 | 版本 | 变更 | 作者 |
+|------|------|------|------|
+| {YYYY-MM-DD} | v1 | 初始版本 | {作者} |

package/templates/extended/contracts/batch_job_contract/review-checklist.md

@@ -0,0 +1,82 @@
+# Batch Job Contract 审查清单
+
+<!-- 本清单是插件通用基线，项目本地审查规则可覆盖 -->
+
+## 结构完整性
+
+- [ ] `id` 字段存在且符合项目 ID 模式（如 `BATCH-{nnn}`）
+- [ ] `title` 清晰描述批处理作业范围
+- [ ] `version` 字段存在且符合语义化版本
+- [ ] `status` 字段存在且为有效值
+- [ ] `schedule` 字段存在且为有效 cron 表达式
+
+## 输入定义
+
+- [ ] 所有数据源已列出
+- [ ] 数据源类型明确（数据库 / 文件 / API / 消息队列）
+- [ ] 输入参数完整且类型明确
+- [ ] 输入格式示例正确
+
+## 输出定义
+
+- [ ] 所有输出目标已列出
+- [ ] 输出目标类型明确
+- [ ] 输出参数完整且类型明确
+- [ ] 输出格式示例正确
+
+## 处理逻辑
+
+- [ ] 主流程步骤清晰
+- [ ] 分片策略已定义（方式、大小、并行度）
+- [ ] 过滤条件已列出
+- [ ] 边界情况处理已说明
+
+## 幂等性
+
+- [ ] 幂等策略已定义
+- [ ] 唯一键组成字段明确
+- [ ] 冲突处理策略已说明
+- [ ] 重复执行行为已定义
+
+## 错误处理
+
+- [ ] 错误分类已定义（数据 / 系统 / 业务）
+- [ ] 每类错误的处理策略已说明
+- [ ] 错误记录方式已定义
+- [ ] 单条失败处理策略已说明
+- [ ] 批量失败处理策略已说明
+- [ ] 作业失败处理策略已说明
+
+## 监控与告警
+
+- [ ] 关键监控指标已定义（处理量、成功数、失败数、时长）
+- [ ] 告警规则已定义
+- [ ] 告警级别和通知方式已说明
+- [ ] 监控阈值合理
+
+## 性能要求
+
+- [ ] 预期数据量已评估
+- [ ] 处理时间要求已定义
+- [ ] 资源限制已说明
+
+## 回滚策略
+
+- [ ] 回滚条件已定义
+- [ ] 回滚方式已说明（手动 / 自动）
+- [ ] 回滚步骤清晰
+- [ ] 数据一致性保证已说明
+
+## 追溯性
+
+- [ ] 关联功能特性存在
+- [ ] 批处理作业可追溯到业务需求
+- [ ] 版本变更可追溯
+- [ ] 关联设计文档存在
+
+## 实现一致性
+
+- [ ] 与实现代码一致
+- [ ] 文档与实际行为匹配
+- [ ] 测试覆盖核心场景
+- [ ] 性能满足要求

package/templates/extended/contracts/batch_job_contract/starter.md

@@ -0,0 +1,158 @@
+---
+id: {BATCH_ID}
+title: {批处理作业名称}
+status: draft
+version: {v1}
+schedule: {调度表达式}
+related_features: []
+---
+
+# {BATCH_ID}: {批处理作业名称}
+
+<!-- 本模板是插件 starter 指导，项目本地模板可完全覆盖 -->
+<!-- 插件模板是入门指导，项目本地模板是权威 -->
+
+## 概述
+
+{描述这个批处理作业的用途、业务场景和主要功能}
+
+## 基础信息
+
+- **版本**：{version}
+- **调度表达式**：{cron 表达式，如 "0 2 * * ?" 表示每天凌晨 2 点}
+- **执行环境**：本地 / K8s CronJob / Airflow / XXL-Job / ElasticJob
+- **超时时间**：{作业最大执行时长}
+- **失败重试**：{是否支持失败重试，最大重试次数}
+
+## 输入定义
+
+### 数据源
+
+| 数据源 | 类型 | 位置 | 说明 |
+|--------|------|------|------|
+| {数据源名称} | 数据库 / 文件 / API / 消息队列 | {位置} | {说明} |
+
+### 输入参数
+
+| 参数名 | 类型 | 必填 | 默认值 | 说明 |
+|--------|------|------|-------|------|
+| {param_name} | {type} | 是/否 | {default} | {参数描述} |
+
+### 输入格式
+
+```
+{输入数据的格式示例}
+```
+
+## 输出定义
+
+### 输出目标
+
+| 目标 | 类型 | 位置 | 说明 |
+|------|------|------|------|
+| {目标名称} | 数据库 / 文件 / API / 消息队列 | {位置} | {说明} |
+
+### 输出参数
+
+| 参数名 | 类型 | 说明 |
+|--------|------|------|
+| {param_name} | {type} | {参数描述} |
+
+### 输出格式
+
+```
+{输出数据的格式示例}
+```
+
+## 处理逻辑
+
+### 主流程
+
+1. {步骤 1：描述}
+2. {步骤 2：描述}
+3. {步骤 3：描述}
+
+### 分片策略
+
+- **分片方式**：{按 ID 范围 / 按时间范围 / 按哈希}
+- **分片大小**：{每片处理的数据量}
+- **并行度**：{最大并行分片数}
+
+### 过滤条件
+
+| 条件 | 字段 | 运算符 | 值 | 说明 |
+|------|------|--------|-----|------|
+| {条件名称} | {field} | = / != / > / < / IN | {value} | {条件描述} |
+
+## 幂等性
+
+- **幂等策略**：{唯一键去重 / 状态检查 / 版本号}
+- **唯一键**：{唯一键的组成字段}
+- **冲突处理**：{跳过 / 覆盖 / 报错}
+- **重复执行**：{是否支持重复执行，重复执行的行为}
+
+## 错误处理
+
+### 错误分类
+
+| 错误类型 | 示例 | 处理策略 |
+|---------|------|---------|
+| 数据错误 | 格式错误、校验失败 | 跳过 + 记录错误日志 |
+| 系统错误 | 数据库连接失败、磁盘满 | 重试 + 告警 |
+| 业务错误 | 状态冲突、业务规则不满足 | 记录 + 人工介入 |
+
+### 错误记录
+
+- **错误日志位置**：{错误日志的存储位置}
+- **错误数据存储**：{错误数据的存储位置，如"错误表 / 错误文件"}
+- **错误报告**：{错误汇总报告的生成方式}
+
+### 失败处理
+
+- **单条失败**：{跳过 / 终止 / 回滚}
+- **批量失败**：{告警阈值、处理策略}
+- **作业失败**：{重试策略、告警方式}
+
+## 监控与告警
+
+### 监控指标
+
+| 指标名称 | 类型 | 说明 |
+|---------|------|------|
+| 处理总量 | Counter | {说明} |
+| 成功数量 | Counter | {说明} |
+| 失败数量 | Counter | {说明} |
+| 处理时长 | Histogram | {说明} |
+| 处理速率 | Gauge | {说明} |
+
+### 告警规则
+
+| 告警名称 | 条件 | 级别 | 通知方式 |
+|---------|------|------|---------|
+| {告警名称} | {条件} | P0 / P1 / P2 | {钉钉 / 邮件 / 短信} |
+
+## 性能要求
+
+- **预期数据量**：{每次处理的数据量}
+- **处理时间要求**：{最大允许处理时间}
+- **资源限制**：{CPU / 内存 / 磁盘限制}
+
+## 回滚策略
+
+- **回滚条件**：{什么情况下需要回滚}
+- **回滚方式**：{手动 / 自动}
+- **回滚步骤**：{回滚的具体步骤}
+- **数据一致性**：{如何保证回滚后的数据一致性}
+
+## 关联制品
+
+- 功能特性：{related_features}
+- 设计文档：{related_designs}
+- 决策：{related_decisions}
+- 数据契约：{related_data_contracts}
+
+## 变更日志
+
+| 日期 | 版本 | 变更 | 作者 |
+|------|------|------|------|
+| {YYYY-MM-DD} | v1 | 初始版本 | {作者} |

package/templates/extended/contracts/cli_contract/review-checklist.md

@@ -0,0 +1,43 @@
+# CLI Contract 审查清单
+
+<!-- 本清单是插件通用基线，项目本地审查规则可覆盖 -->
+
+## 结构完整性
+
+- [ ] `id` 字段存在且符合项目 ID 模式（如 `CLI-{nnn}` 或 `{tool}-CLI-{version}`）
+- [ ] `title` 清晰描述 CLI 工具
+- [ ] `version` 字段存在且符合语义化版本
+- [ ] 命令结构层级清晰
+
+## 命令质量
+
+- [ ] 每个命令有清晰描述
+- [ ] 选项和参数类型明确
+- [ ] 必填/可选标识正确
+- [ ] 默认值已说明
+
+## 用户体验
+
+- [ ] 帮助文本准确
+- [ ] 错误信息有指导性
+- [ ] 退出码语义明确
+- [ ] 示例覆盖常见场景
+
+## 向后兼容
+
+- [ ] 破坏性变更已记录
+- [ ] 废弃选项有迁移路径
+- [ ] 版本升级指南存在
+
+## 追溯性
+
+- [ ] 关联功能特性存在
+- [ ] 命令可追溯到用户需求
+- [ ] 版本变更可追溯
+
+## 实现一致性
+
+- [ ] 与实现代码一致
+- [ ] 文档与实际行为匹配
+- [ ] 测试覆盖所有命令
+- [ ] 自动补全配置正确（如适用）

package/templates/extended/contracts/cli_contract/starter.md

@@ -0,0 +1,93 @@
+---
+id: {CLI_ID}
+title: {CLI 工具名称}
+status: draft
+version: {v1}
+related_features: []
+---
+
+# {CLI_ID}: {CLI 工具名称}
+
+<!-- 本模板是插件 starter 指导，项目本地模板可完全覆盖 -->
+<!-- 插件模板是入门指导，项目本地模板是权威 -->
+
+## 概述
+
+{描述这个 CLI 工具的用途、目标用户和主要能力}
+
+## 基础信息
+
+- **版本**：{version}
+- **命令名称**：{command}
+- **安装方式**：{npm/pip/binary}
+
+## 命令结构
+
+```bash
+{command} [全局选项] <命令> [命令选项] [参数]
+```
+
+## 全局选项
+
+| 选项 | 简写 | 描述 | 默认值 |
+|------|------|------|--------|
+| --help | -h | 显示帮助 | - |
+| --version | -v | 显示版本 | - |
+| --verbose | | 详细输出 | false |
+
+## 命令列表
+
+### {command} {子命令}
+
+**描述**：{命令描述}
+
+**用法**：
+```bash
+{command} {子命令} [选项] <参数>
+```
+
+**选项**：
+
+| 选项 | 简写 | 描述 | 默认值 |
+|------|------|------|--------|
+| --option1 | -o | {描述} | {默认值} |
+
+**参数**：
+
+| 参数 | 必填 | 描述 |
+|------|------|------|
+| {param} | {yes/no} | {描述} |
+
+**示例**：
+```bash
+{command} {子命令} --option1 value arg1
+```
+
+**退出码**：
+
+| 退出码 | 描述 |
+|--------|------|
+| 0 | 成功 |
+| 1 | 一般错误 |
+| 2 | 参数错误 |
+
+## 配置文件
+
+{描述配置文件位置、格式和选项}
+
+## 环境变量
+
+| 变量 | 描述 | 优先级 |
+|------|------|--------|
+| {VAR_NAME} | {描述} | {高于/低于}配置文件 |
+
+## 关联制品
+
+- 功能特性：{related_features}
+- 设计文档：{related_designs}
+
+## 变更日志
+
+| 日期 | 版本 | 变更 | 作者 |
+|------|------|------|------|
+| {YYYY-MM-DD} | v1 | 初始版本 | {作者} |

package/templates/extended/contracts/data_contract/review-checklist.md

@@ -0,0 +1,45 @@
+# Data Contract 审查清单
+
+<!-- 本清单是插件通用基线，项目本地审查规则可覆盖 -->
+
+## 结构完整性
+
+- [ ] `id` 字段存在且符合项目 ID 模式（如 `DATA-{nnn}`）
+- [ ] `title` 清晰描述数据契约范围
+- [ ] `version` 字段存在且符合语义化版本
+- [ ] 数据格式已指定
+
+## 数据模型质量
+
+- [ ] Schema 定义完整
+- [ ] 字段类型和约束明确
+- [ ] 必填/可选标识正确
+- [ ] 枚举值有文档说明
+
+## 数据质量
+
+- [ ] 数据质量规则已定义
+- [ ] 验证方法可执行
+- [ ] 监控指标已配置
+- [ ] 告警阈值已设定
+
+## 版本兼容性
+
+- [ ] 兼容变更规则明确
+- [ ] 破坏性变更已记录
+- [ ] 迁移路径已规划
+- [ ] 版本升级指南存在
+
+## 追溯性
+
+- [ ] 关联功能特性存在
+- [ ] 数据生产者已识别
+- [ ] 数据消费者已识别
+- [ ] 数据血缘可追溯
+
+## 实现一致性
+
+- [ ] 与实际数据格式一致
+- [ ] 文档与实现匹配
+- [ ] 测试覆盖所有字段
+- [ ] 数据验证已集成