visual-spec 0.1.0 → 0.1.1

package/docs/structure.md

@@ -1,69 +0,0 @@
-# 目录结构说明
-
-本文说明两类目录结构：
-- 项目内 `/specs/` 产物目录结构：skill 在目标项目中生成的需求与设计产物
-
-
-## 目标项目目录结构
-
-skill 会在目标项目根目录生成 `/specs/` 产物（按命令阶段逐步补齐），并维护少量项目级配置与材料归档目录。典型结构如下：
-
-```text
-<your-project>/
-├─ docs/                                  # 需求材料归档目录（/vspec:new 自动创建）
-│  ├─ legacy/                             # 遗留系统材料（旧系统功能、旧权限、旧交互、旧接口说明等）
-│  ├─ current/                            # 本次新增/补充材料（新目标、差异说明、新流程、新 UI 约束等）
-│  │  └─ file_list.md                     # 升级分析入口清单（/vspec:upgrade 读取/生成）
-│  ├─ change/                             # 变更材料（/vspec:change 读取）
-│  │  └─ file_list.md                     # 变更输入入口清单（可选，存在则按顺序读取）
-│  ├─ refine/                             # 需求修订材料（/vspec:refine 读取）
-│  │  └─ file_list.md                     # 修订输入入口清单（可选，存在则按顺序读取）
-│  ├─ templates/                          # 各类模板（PRD/文案/页面/表格模板等，可选）
-│  ├─ texts/                              # 文案材料（提示语、错误文案、协议文案、消息模板等，可选）
-│  └─ assets/                             # 静态资源（设计稿/截图/原型/图片等，可选）
-├─ scheme.yaml                            # 原型工程技术栈选择（/vspec:verify 使用；不存在会自动创建默认值）
-└─ specs/
-   ├─ background/                         # 背景分析与通用资料
-   │  ├─ original.md                      # 原始需求（或等价输入）
-   │  ├─ stakeholders.md                  # 干系人
-   │  ├─ roles.md                         # 角色与任务
-   │  ├─ terms.md                         # 术语表
-   │  ├─ scenarios.md                     # 场景清单
-   │  ├─ scenario_details/                # 场景细节（按节点拆分：每节点 pre_post.md/constraints.md/variations.md/boundaries.md/symmetry.md）
-   │  ├─ dependencies.md                  # 外部依赖
-   │  └─ questions.md                     # 待确认问题清单（进入 verify 前需清零未回答/允许跳过）
-   ├─ flows/                              # 流程图（PlantUML）
-   │  └─ *.puml
-   ├─ functions/                           # 功能清单（按模块拆分）
-   │  └─ *.md
-   ├─ details/                             # 逐功能点的细节设计（/vspec:detail 输出）
-   │  └─ <module_slug>/
-   │     ├─ rbac/                          # 权限细化
-   │     ├─ data_permission/               # 数据权限
-   │     ├─ page_load/
-   │     ├─ interaction/
-   │     ├─ validation_matrix/
-   │     ├─ logging_matrix/
-   │     ├─ notification_matrix/
-   │     ├─ mq/
-   │     ├─ nfp/                           # 非功能性需求（性能/压测/安全/兼容/容错/稳定）
-   │     ├─ file_import/
-   │     ├─ file_export/
-   │     └─ cron_job/
-   ├─ models/                              # 数据模型（/vspec:verify 输出）
-   │  ├─ *.md
-   │  └─ README.md
-   ├─ prototypes/                          # 原型工程与验证页（/vspec:verify 输出）
-   │  └─ ...
-   ├─ acceptance/                          # 验收用例（/vspec:accept 输出）
-   │  ├─ index.md
-   │  └─ ...
-   ├─ qc_report.md                         # 质量检查报告（/vspec:qc 输出）
-   ├─ plan_estimate.md                     # 估算（/vspec:plan 输出）
-   ├─ plan_schedule.html                   # 排期页面（/vspec:plan 输出）
-   └─ change_log.md                        # 变更日志（/vspec:change 输出）
-```
-
-补充说明：
-- `docs/`：用于存放与本需求相关的业务材料与交付对齐资料；建议统一放入 `legacy/current/change/refine/templates/texts/assets` 等子目录，并在文件名中体现来源与版本。
-- `scheme.yaml`：用于指定 `/vspec:verify` 生成“可运行原型工程”时采用的技术栈与选项；优先读取项目根目录 `scheme.yaml`，若不存在才读取 `/specs/scheme.yaml`，两者都不存在则会创建默认的 `scheme.yaml`。

package/docs/workflows.md

@@ -1,69 +0,0 @@
-## 工作流程
-
-### 0. 准备
-
-- 在你的项目根目录（包含 `.trae/`）安装该 skill
-- 确保 `.trae/skills/starter-skill/` 已出现在项目内（安装方式见下方“安装”）
-
-### 1. 需求分析（/vspec:new）
-
-- 输入原始需求
-- 回答待确认问题（关键假设、范围、规则、依赖）
-- 得到 `/specs/` 下基础规格产物：角色/术语/流程/场景/功能清单/依赖/问题清单
-
-### 2. 方案验证（/vspec:verify）
-
-- 基于 `/specs/` 产物生成：
-  - `/specs/models/*.md`：实体与字段、关系、状态机、索引、外部字段来源
-  - `/specs/prototypes/`：Vue + Ant Design Vue 原型与 `scenario.html` 场景确认页
-- 目标：尽早暴露理解偏差，收敛到可评审方案
-
-补充：原型分段生成（可选）
-
-- 当原型规模较大或希望更可控地按链路落地时，可改用拆分命令增量生成：
-  - `/vspec:proto-apply`：聚焦申请链路页面与工作台差异
-  - `/vspec:proto-approve`：聚焦审批链路页面与工作台差异
-  - `/vspec:proto-execute`：聚焦执行链路页面（含移动端 `/m/*`）
-  - `/vspec:proto-crud`：聚焦配置/主数据类 CRUD 管理页
-
-### 3. 细节梳理（/vspec:detail）
-
-- 以 `/specs/functions/*` 为输入，逐功能点输出 `/specs/details/<function_slug>/`
-- 目标：把“需求”变成可实现的设计输入：
-  - 权限（RBAC 到控件级）与数据权限
-  - 加载/交互/校验矩阵
-  - 提交后检查/处理/跳转
-  - 日志矩阵/通知矩阵/MQ 规格/导入导出/定时任务
-
-### 4. 验收用例（/vspec:accept）
-
-- 生成验收用例到 `/specs/acceptance/`
-- 目标：明确验收口径与覆盖范围（主流程/异常/边界/权限/数据权限）
-
-### 5. 自动化测试（/vspec:test）
-
-- 读取验收用例与仓库现有测试框架
-- 生成最小可运行的 E2E/API/单元测试集合
-
-### 6. 集成开发（/vspec:impl）
-
-- 读取规格、细节、模型与依赖
-- 按仓库现有技术栈与约定生成前后端集成代码（接口契约 → 后端实现 → 前端集成）
-
-### 7. 排期规划（/vspec:plan）
-
-- 从功能与场景拆成用户故事，估算人天并按迭代排期
-- 输出：
-  - `/specs/plan.md`
-  - `/specs/story_map.html`（用户故事地图）
-
-### 8. 变更响应（/vspec:change）
-
-- 输入变更描述
-- 输出影响分析与变更日志，并同步更新受影响产物与用例
-
-## 安装（npm）
-
-- 推荐在你的项目根目录执行：`npm install <git-url>`
-- 安装完成后会将 skill 复制到：`<你的项目>/.trae/skills/starter-skill/`
-- 如需手动执行安装：`npx vreq-skill --force`