Skillget

visual-spec

agent
Guvenlik Denetimi
Basarisiz
Health Gecti
  • License — License: MIT
  • Description — Repository has a description
  • Active repo — Last push 0 days ago
  • Community trust — 28 GitHub stars
Code Basarisiz
  • spawnSync — Synchronous process spawning in bin/vspec.cjs
  • process.env — Environment variable access in bin/vspec.cjs
  • network request — Outbound network request in docs/en-US/scheme.example.yaml
  • network request — Outbound network request in docs/ja-JP/scheme.example.yaml
  • network request — Outbound network request in docs/zh-CN/scheme.example.yaml
  • spawnSync — Synchronous process spawning in scripts/build_skill.cjs
  • fs.rmSync — Destructive file system operation in scripts/build_skill.cjs
  • fs module — File system access in scripts/build_skill.cjs
  • process.env — Environment variable access in scripts/postinstall.cjs
Permissions Gecti
  • Permissions — No dangerous permissions requested

Bu listing icin henuz AI raporu yok.

SUMMARY

Give your short business requirement, follow instructions, answer a few questions, get your specification, codes, tests.

README.md

visual-spec

English | 中文 | 日本語

This repo provides a requirements analysis and delivery assistant Skill. It offers a /vspec:* command-driven workflow that turns raw requirements into reviewable, shippable artifacts: specs, data models, runnable prototypes, detailed design, acceptance cases, tests, and integrated implementation inputs.

It is designed around an independently-owned IP methodology: “visualized requirements analysis”. The goal is to standardize and make the end-to-end workflow (clarification → design → validation) more visual, traceable, and reusable, so teams can reduce communication overhead and avoid rework.

Version: 0.1.13 (2026-04-12)

Quick Installation

Install the Skill into your AI editor configuration directory (Trae / Claude Code / Cursor / GitHub Copilot, etc.):

npx skills add visual-req/visual-spec --skill visual-spec

Docs:

Overview

  • Requirements analysis: generate background, stakeholders, roles, terms, flows, scenarios, details, dependencies, function list, and open questions
  • Solution verification: generate data models, runnable prototypes, and a scenario review page
  • Detailed design: produce RBAC/data-permission/interaction/validation/logging/notification/MQ/import-export/cron specs per function
  • Acceptance & testing: generate acceptance cases and automated test code
  • Integrated implementation: generate backend + frontend integrated code (aligned with the repo’s actual stack and conventions)
  • Planning: estimate and schedule based on the function list (HTML output)

Commands

Command Purpose Main inputs Main outputs
/vspec:new Generate baseline spec artifacts raw requirement text + optional /docs/current/* /specs/ (background/functions/flows, etc.)
/vspec:refine Refine an existing visual-spec requirement and sync downstream artifacts /docs/refine/refine.md or prompt-window pasted changes or command args updates /specs/background/original.md + sync updates /specs/details/, /specs/prototypes/, existing /specs/backend/
/vspec:refine-q Merge answered questions back into the canonical spec /specs/background/questions.md (answered items) updates /specs/background/original.md and marks answers in questions.md
/vspec:detail Generate per-function detailed specs /specs/functions/* + supporting artifacts /specs/details/
/vspec:verify Generate data models and a stack-selected runnable prototype /scheme.yaml + non-empty /specs/details/ /specs/models/, /specs/prototypes/
/vspec:accept Generate acceptance test cases functions + scenarios + details + models /specs/acceptance/
/vspec:append-test Generate automated test code acceptance cases + existing test framework existing test directories or /tests/
/vspec:impl Generate integrated backend + frontend implementation inputs details + models + dependencies /specs/backend/ (if enabled) and related integration code
/vspec:upgrade Upgrade/redesign based on legacy + new inputs /docs/legacy/* + /docs/current/* regenerated /specs/ + synced technical selections to /scheme.yaml
/vspec:qc Run quality checks on generated artifacts /specs/ + built-in/project standards /specs/qc_report.json, /specs/qc_report.html
/vspec:plan Generate estimation and schedule functions + details + /specs/qc_report.json /specs/plan/plan_estimate.md, /specs/plan/plan_schedule.html

Documentation

Doc Description Link
Getting started Run a full workflow end-to-end docs/en-US/getting-started.md
Commands /vspec:* reference docs/en-US/commands.md
Structure Directory structure and artifacts docs/en-US/structure.md
Workflows Visual workflow overview docs/en-US/workflows.md
Installation Installation & setup docs/en-US/installation.md

Upgrade vs Refine

  • upgrade: for legacy-system upgrade/rebuild scenarios; it uses /docs/legacy/ + /docs/current/ (and related template/text/assets inputs) to produce an upgraded target spec and technical selections.
  • refine: for improving/adjusting an already visual-spec-structured requirement (legacy or new); it updates the canonical requirement and keeps downstream artifacts in sync.

Directory Structure

  • skills/visual-spec/SKILL.md: Skill definition and command workflow
  • skills/visual-spec/prompts/: prompt files used by each command

Licensing / Plans

  • prompts/harness/* (post-run validation commands) is a paid feature and is only available in the Pro edition.
  • Pro edition adds broader quality checks across commands (e.g. prototype stack verification, click-no-op detection, mobile UX checks, price formatting checks, and backend MVC/test coverage checks) and requires a paid plan to enable.

Quick Start

  1. Install the Skill: npx skills add visual-req/visual-spec --skill visual-spec
  2. Run /vspec:new and input your raw requirement text.
  3. Answer the "Open Questions" when prompted to close gaps and assumptions.
  4. Execute the following commands in sequence to generate the final artifacts:
    • /vspec:detail: Generate detailed specs (/specs/details/)
    • /vspec:verify: Generate data models and runnable prototypes (/specs/models/, /specs/prototypes/)
    • /vspec:qc: Generate quality reports (/specs/qc_report.json, /specs/qc_report.html)
    • /vspec:plan (Optional): Generate estimation and schedule (/specs/plan/)
  5. When requirements change: write the updates in /docs/refine/refine.md (or paste them directly), then run /vspec:refine to keep downstream artifacts in sync.

Yorumlar (0)

Sonuc bulunamadi