Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 28 additions & 4 deletions .github/workflows/community-smoke.yml
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,15 @@ jobs:
test -f .specify/presets/workflow-preset/.composed/speckit.tasks.md

test -f .claude/skills/speckit-arch-generate/SKILL.md
test -f .claude/skills/speckit-preview-html/SKILL.md
for preview_skill in \
speckit-preview-low-md \
speckit-preview-low-html \
speckit-preview-mid-md \
speckit-preview-mid-html \
speckit-preview-high-md \
speckit-preview-high-html; do
test -f ".claude/skills/$preview_skill/SKILL.md"
done
test -f .claude/skills/speckit-repository-governance-refresh/SKILL.md
test -f .claude/skills/speckit-specify/SKILL.md
test -f .claude/skills/speckit-clarify/SKILL.md
Expand All @@ -119,7 +127,15 @@ jobs:
test ! -d .claude/skills/speckit-arch-reverse
;;
preview)
test ! -d .claude/skills/speckit-preview-html
for preview_skill in \
speckit-preview-low-md \
speckit-preview-low-html \
speckit-preview-mid-md \
speckit-preview-mid-html \
speckit-preview-high-md \
speckit-preview-high-html; do
test ! -d ".claude/skills/$preview_skill"
done
;;
repository-governance)
test ! -d .claude/skills/speckit-repository-governance-refresh
Expand All @@ -136,8 +152,16 @@ jobs:
grep -q "4+1 architecture workflow" .claude/skills/speckit-arch-generate/SKILL.md
;;
preview)
test -f .claude/skills/speckit-preview-html/SKILL.md
grep -q "self-contained interactive HTML prototype" .claude/skills/speckit-preview-html/SKILL.md
for preview_skill in \
speckit-preview-low-md \
speckit-preview-low-html \
speckit-preview-mid-md \
speckit-preview-mid-html \
speckit-preview-high-md \
speckit-preview-high-html; do
test -f ".claude/skills/$preview_skill/SKILL.md"
grep -q "evidence-backed" ".claude/skills/$preview_skill/SKILL.md"
done
;;
repository-governance)
test -f .claude/skills/speckit-repository-governance-refresh/SKILL.md
Expand Down
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ specify integration list
| --- | --- | --- | --- |
| ARCH SSOT | `arch` 扩展 | `/speckit.arch.generate`、`/speckit.arch.reverse`、`.specify/memory/architecture*.md` | 把项目级 4+1 架构视图沉淀为稳定记忆,避免每个 feature 重新猜边界、约束和部署假设。 |
| 仓库治理规范 | `repository-governance` 扩展 | `/speckit.repository-governance.refresh`、受管 `SPECKIT GOVERNANCE` 段 | 统一 agent 的 SSOT 读取顺序、目录责任、平台适配和仓库事实证据。 |
| UI/UX 需求规格 | `workflow-preset` + `preview` 扩展 | `spec.md` 用户旅程、`behavior/uif.intent.json`、`contracts/uif/`、`/speckit.preview.html` | 先把界面状态、断点、用户路径和交互假设写成规格/契约,再生成可打开的 HTML 原型评审。 |
| UI/UX 需求规格 | `workflow-preset` + `preview` 扩展 | `spec.md` 用户旅程、`behavior/uif.intent.json`、`contracts/uif/`、`/speckit.preview.mid-html` | 先把界面状态、断点、用户路径和交互假设写成规格/契约,再生成可打开的预览产物评审。 |
| BDD 引入 | `workflow-preset` | `/speckit.checklist`、`checklists/behavior-testability.md`、`contracts/bdd/` | 在规划前检查 Given/When/Then、可观察结果、边界和 NFR 声明,避免不可验证需求进入实现。 |
| 任务期验证策略 | `workflow-preset` | `/speckit.tasks`、`tasks.md` 内联测试层级和证据要求 | 从 BDD、UIF、行为契约、接口契约、`research.md`、`quickstart.md` 派生验证任务,不再依赖散落的测试策略说明。 |
| imp subagent 矩阵 | `workflow-preset` | `/speckit.implement`、Core/Vertical Planner/Worker、`handoffs/implement/<run-id>/` | 把大实现拆成按 vertical capability 隔离的 handoff,让 Codex、Claude、Gemini、Copilot 等 runtime 使用各自 subagent/worker 模式执行。 |
Expand All @@ -168,7 +168,7 @@ specify integration list
| 扩展 | 默认状态 | 你会用它做什么 |
| --- | --- | --- |
| `arch` | `specify init` 默认安装 | 生成或反向生成项目级 4+1 架构视图,形成 `.specify/memory/architecture*.md` 架构记忆。 |
| `preview` | `specify init` 默认安装 | 根据当前 feature 的规格和计划生成 `specs/<feature>/preview/index.html`,用于实现前验证 UI 和交互假设。 |
| `preview` | `specify init` 默认安装 | 根据当前 feature 的规格和计划生成低/中/高保真 Markdown wireflow 或自包含 HTML 预览,用于实现前验证 UI 和交互假设。 |
| `repository-governance` | `specify init` 默认安装 | 生成 Repository Governance Framework 治理说明,包含垂直 SSOT 注册、读取顺序、缺失 SSOT 处理和仓库事实证据。 |
| `git` | 初始化时默认安装,传 `--no-git` 可跳过 | 初始化 Git、创建 feature branch、校验分支、检测 remote,并可配置自动提交。 |
| `template` | 开发模板 | 给扩展作者复制使用,不是普通项目必装扩展。 |
Expand All @@ -195,7 +195,9 @@ specify extension info arch
```text
/speckit.arch.generate
/speckit.arch.reverse
/speckit.preview.html
/speckit.preview.low-md
/speckit.preview.mid-html
/speckit.preview.high-html
/speckit.repository-governance.refresh
```

Expand Down Expand Up @@ -228,7 +230,7 @@ specify preset info workflow-preset
- 接手旧仓库:跑 `/speckit.arch.reverse`,先从仓库事实反推架构记忆。
- 团队使用多个 agent 或新人频繁接手:跑 `/speckit.repository-governance.refresh`,把目录责任、SSOT 边界和 agent 执行规则写入上下文。
- 希望引入 BDD:保留默认 `workflow-preset`,让 `/speckit.checklist` 在规划前检查 BDD readiness,让 `/speckit.plan` 生成 BDD/UIF/fixture 行为草稿和正式契约。
- 做前端或交互功能:在 `/speckit.specify` 或 `/speckit.plan` 后跑 `/speckit.preview.html`,先看原型再实现
- 做前端或交互功能:在 `/speckit.specify` 或 `/speckit.plan` 后跑 `/speckit.preview.mid-html` 或对应保真的 `*-md`/`*-html` 命令,先看预览再实现
- 中大型实现或跨模块改动:使用默认 `/speckit.implement`,让 Core Agent 生成 handoff manifest,Vertical Planner 拆分能力维度,Worker 按允许路径执行并写 receipt。
- 需要实现后复核:保留 Final Code Review task,要求 code review receipt 检查设计、sequence、contract、quickstart 和数据副作用。
- 希望 feature 分支和提交更规范:保留 `git` 扩展,按需要配置 `.specify/extensions/git/git-config.yml`。
Expand Down Expand Up @@ -312,7 +314,7 @@ AGENTS.md
/speckit.arch.generate
/speckit.specify
/speckit.clarify
/speckit.preview.html
/speckit.preview.mid-html
/speckit.plan
/speckit.tasks
/speckit.analyze
Expand Down Expand Up @@ -385,7 +387,7 @@ specify preset remove lean

- 写 `/speckit.specify` 时只写需求和业务规则,技术栈留给 `/speckit.plan`。
- 在 `/speckit.plan` 前运行 `/speckit.clarify`,可以减少实现阶段反复改规格。
- 对 UI 或流程不确定的功能,先用 `/speckit.preview.html` 看一个可打开的 HTML 原型
- 对 UI 或流程不确定的功能,先用 `/speckit.preview.low-md`、`/speckit.preview.mid-html` 或 `/speckit.preview.high-html` 看一个保真度合适的预览
- 对中大型功能,保留默认 `workflow-preset`,让任务和实现阶段通过验证证据、handoff 和 receipt 留下可审查记录。
- 对非常小的实验,使用 `lean`,减少模板负担。
- 如果 agent 生成了你没要求的复杂设计,让它回到 `spec.md`、`plan.md` 和 `.specify/memory/constitution.md` 逐条解释依据。
Expand Down
2 changes: 1 addition & 1 deletion docs/community/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@ The following community-contributed extensions are available in [`catalog.commun
| GitHub Issues Integration 2 | Creates and syncs local specs from an existing GitHub issue | `integration` | Read+Write | [spec-kit-issue](https://github.com/aaronrsun/spec-kit-issue) |
| Improve Extension | Audits any codebase as a senior advisor and writes prioritized, self-contained spec prompts under specs/ that the spec-kit lifecycle can process | `process` | Read+Write | [spec-kit-improve](https://github.com/d0whc3r/spec-kit-improve) |
| Intake | Extract and validate SDD-ready intake artifacts from PRDs, visual designs, test cases, and other software sources | `docs` | Read+Write | [spec-kit-intake](https://github.com/bigsmartben/spec-kit-intake) |
| Interactive HTML Preview | Generate self-contained interactive HTML prototypes from Spec Kit artifacts | `docs` | Read+Write | [spec-kit-preview](https://github.com/bigsmartben/spec-kit-preview) |
| Intelligent Agent Orchestrator | Cross-catalog agent discovery and intelligent prompt-to-command routing | `process` | Read+Write | [spec-kit-orchestrator](https://github.com/pragya247/spec-kit-orchestrator) |
| Iterate | Iterate on spec documents with a two-phase define-and-apply workflow — refine specs mid-implementation and go straight back to building | `docs` | Read+Write | [spec-kit-iterate](https://github.com/imviancagrace/spec-kit-iterate) |
| Jira Integration | Create Jira Epics, Stories, and Issues from spec-kit specifications and task breakdowns with configurable hierarchy and custom field support | `integration` | Read+Write | [spec-kit-jira](https://github.com/mbachorik/spec-kit-jira) |
Expand Down Expand Up @@ -111,6 +110,7 @@ The following community-contributed extensions are available in [`catalog.commun
| Spec Changelog | Auto-generate changelogs and release notes from spec git history and requirement diffs | `docs` | Read-only | [spec-kit-changelog](https://github.com/Quratulain-bilal/spec-kit-changelog) |
| Spec Critique Extension | Dual-lens critical review of spec and plan from product strategy and engineering risk perspectives | `docs` | Read-only | [spec-kit-critique](https://github.com/arunt14/spec-kit-critique) |
| Spec Diagram | Auto-generate Mermaid diagrams of SDD workflow state, feature progress, and task dependencies | `visibility` | Read-only | [spec-kit-diagram-](https://github.com/Quratulain-bilal/spec-kit-diagram-) |
| Spec Kit Preview | Generate evidence-backed low, mid, or high fidelity previews from Spec Kit artifacts as Markdown or self-contained HTML | `docs` | Read+Write | [spec-kit-preview](https://github.com/bigsmartben/spec-kit-preview) |
| Spec Kit Schedule | Optimal multi-agent task scheduling via CP-SAT — DAG precedence, hallucination-aware caps, file-conflict avoidance, stochastic durations, replanning, and interactive HTML output | `process` | Read+Write | [spec-kit-schedule](https://github.com/jfranc38/spec-kit-schedule) |
| Spec Kit TLDR | Render a feature's spec.md / plan.md into a review-oriented TLDR (self-contained HTML dashboard + PR-native Markdown) that surfaces risks for faster PR review. | `visibility` | Read+Write | [speckit-tldr](https://github.com/qurore/speckit-tldr) |
| Spec Orchestrator | Cross-feature orchestration — track state, select tasks, and detect conflicts across parallel specs | `process` | Read-only | [spec-kit-orchestrator](https://github.com/Quratulain-bilal/spec-kit-orchestrator) |
Expand Down
10 changes: 5 additions & 5 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
/speckit.specify
/speckit.clarify
/speckit.checklist
/speckit.preview.html
/speckit.preview.mid-html
/speckit.plan
/speckit.tasks
/speckit.analyze
Expand Down Expand Up @@ -178,19 +178,19 @@ specs/<feature>/checklists/behavior-testability.md

## 6. 预览 UI/UX 规格

对 UI、流程或交互有不确定性时,先生成自包含 HTML 原型
对 UI、流程或交互有不确定性时,先生成保真度合适的预览产物

```text
/speckit.preview.html mobile album browsing and reorder flow
/speckit.preview.mid-html mobile album browsing and reorder flow
```

打开输出文件评审:

```text
specs/<feature>/preview/index.html
specs/<feature>/preview/wireflow-mid.html
```

这个文件只用于实现前评审 flow、信息架构、状态和交互假设,不会修改生产代码。
这个文件只用于实现前评审 flow、信息架构、状态和交互假设,不会修改生产代码。也可以按需要使用 `/speckit.preview.low-md`、`/speckit.preview.low-html`、`/speckit.preview.high-md` 或 `/speckit.preview.high-html`。

## 7. 生成计划与行为契约

Expand Down
14 changes: 8 additions & 6 deletions extensions/catalog.community.json
Original file line number Diff line number Diff line change
Expand Up @@ -2391,12 +2391,12 @@
"updated_at": "2026-03-18T00:00:00Z"
},
"preview": {
"name": "Interactive HTML Preview",
"name": "Spec Kit Preview",
"id": "preview",
"description": "Generate self-contained interactive HTML prototypes from Spec Kit artifacts",
"description": "Generate evidence-backed low, mid, or high fidelity previews from Spec Kit artifacts as Markdown or self-contained HTML",
"author": "bigsmartben",
"version": "1.0.0",
"download_url": "https://github.com/bigsmartben/spec-kit-preview/archive/refs/tags/v1.0.0.zip",
"version": "1.1.0",
"download_url": "https://github.com/bigsmartben/spec-kit-preview/archive/refs/tags/v1.1.0.zip",
"repository": "https://github.com/bigsmartben/spec-kit-preview",
"homepage": "https://github.com/bigsmartben/spec-kit-preview",
"documentation": "https://github.com/bigsmartben/spec-kit-preview/blob/main/README.md",
Expand All @@ -2408,20 +2408,22 @@
"speckit_version": ">=0.8.10.dev0"
},
"provides": {
"commands": 1,
"commands": 6,
"hooks": 0
},
"tags": [
"preview",
"prototype",
"html",
"markdown",
"wireflow",
"ux"
],
"verified": false,
"downloads": 0,
"stars": 0,
"created_at": "2026-05-15T00:00:00Z",
"updated_at": "2026-05-15T00:00:00Z"
"updated_at": "2026-06-23T00:00:00Z"
},
"product": {
"name": "Product Spec Extension",
Expand Down
12 changes: 7 additions & 5 deletions extensions/catalog.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"schema_version": "1.0",
"updated_at": "2026-06-05T00:00:00Z",
"updated_at": "2026-06-23T00:00:00Z",
"catalog_url": "https://raw.githubusercontent.com/github/spec-kit/main/extensions/catalog.json",
"extensions": {
"agent-context": {
Expand Down Expand Up @@ -70,10 +70,10 @@
]
},
"preview": {
"name": "Interactive HTML Preview",
"name": "Spec Kit Preview",
"id": "preview",
"version": "1.0.0",
"description": "Generate self-contained interactive HTML prototypes from Spec Kit artifacts",
"version": "1.1.0",
"description": "Generate evidence-backed low, mid, or high fidelity previews from Spec Kit artifacts as Markdown or self-contained HTML",
"author": "bigsmartben",
"repository": "https://github.com/bigsmartben/spec-kit-preview",
"license": "MIT",
Expand All @@ -82,12 +82,14 @@
"speckit_version": ">=0.8.10.dev0"
},
"provides": {
"commands": 1
"commands": 6
},
"tags": [
"preview",
"prototype",
"html",
"markdown",
"wireflow",
"ux"
]
},
Expand Down
35 changes: 21 additions & 14 deletions extensions/preview/CATALOG-SUBMISSION.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,41 @@
# Spec Kit Extension Submission

Extension ID: preview
Name: Interactive HTML Preview
Version: 1.0.0
Description: Generate self-contained interactive HTML prototypes from Spec Kit artifacts
Name: Spec Kit Preview
Version: 1.1.0
Description: Generate evidence-backed low, mid, or high fidelity previews from Spec Kit artifacts as Markdown or self-contained HTML
Author: bigsmartben
Repository URL: https://github.com/bigsmartben/spec-kit-preview
Download URL: https://github.com/bigsmartben/spec-kit-preview/archive/refs/tags/v1.0.0.zip
Download URL: https://github.com/bigsmartben/spec-kit-preview/archive/refs/tags/v1.1.0.zip
Documentation URL: https://github.com/bigsmartben/spec-kit-preview/blob/main/README.md
License: MIT
Required Spec Kit version: >=0.8.10.dev0
Commands count: 1
Commands count: 6
Hooks count: 0
Tags: preview, prototype, html, ux
Tags: preview, prototype, html, markdown, wireflow, ux

## Key Features

- Adds `speckit.preview.html`.
- Generates `specs/<feature>/preview/index.html`.
- Keeps prototypes self-contained with inline CSS and JavaScript.
- Adds `speckit.preview.low-md` and `speckit.preview.low-html`.
- Adds `speckit.preview.mid-md` and `speckit.preview.mid-html`.
- Adds `speckit.preview.high-md` and `speckit.preview.high-html`.
- Generates `specs/<feature>/preview/wireflow-low.md`, `wireflow-mid.md`, or `wireflow-high.md`.
- Generates matching `wireflow-low.html`, `wireflow-mid.html`, or `wireflow-high.html`.
- Uses fixed templates under `templates/preview/` for output sections, table schemas, HTML shells, and preserved-review slots.
- Uses `schemas/preview/contract.json` and `schemas/preview/contract.schema.json` as the structural validation source.
- Keeps previews self-contained with inline CSS and fidelity-appropriate JavaScript.
- Explicitly avoids production source, spec, plan, and task file changes.
- Captures prototype assumptions and unresolved questions.
- Captures coverage evidence, inferred assumptions, unsupported items, and unresolved questions.

## Testing Performed

- `python3 -m py_compile tests/validate-extension.py`
- `python3 tests/validate-extension.py`
- Installed locally with `specify extension add --dev /home/administrator/github/spec-kit-preview` in a fresh Spec Kit project.
- Verified `.qwen/commands/speckit.preview.html.md` was registered.
- Verified six `.qwen/commands/speckit.preview.*.md` commands were registered.
- Verified installed extension contents excluded `tests/` via `.extensionignore`.
- Created release `v1.0.0`.
- Installed release ZIP in a fresh Spec Kit project:
`specify extension add preview --from https://github.com/bigsmartben/spec-kit-preview/archive/refs/tags/v1.0.0.zip`
## Release Checklist

- Create release `v1.1.0` from this revision.
- Install release ZIP in a fresh Spec Kit project:
`specify extension add preview --from https://github.com/bigsmartben/spec-kit-preview/archive/refs/tags/v1.1.0.zip`
9 changes: 9 additions & 0 deletions extensions/preview/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Changelog

## v1.1.0

- Adds six preview commands: `speckit.preview.low-md`, `speckit.preview.low-html`, `speckit.preview.mid-md`, `speckit.preview.mid-html`, `speckit.preview.high-md`, and `speckit.preview.high-html`.
- Adds separate Markdown and HTML output designs for low, mid, and high fidelity preview artifacts.
- Adds fixed preview templates under `templates/preview/` so command prompts no longer define output structure inline.
- Adds schema-backed validation contracts under `schemas/preview/` for command/template structure checks.
- Adds consistent active feature detection and update-preservation guidance across preview commands.
- Strengthens package validation for command/template responsibility separation, output boundaries, and fidelity-specific contracts.

## v1.0.0

- Initial release.
Expand Down
Loading