用户故事格式

GhassenAZZOUZ2026-10-25查看 1652复制 35

仅供参考——本项目用户故事正文(故事、Gherkin 验收标准、测试场景、缺失信息、DoD)及其验收标准/场景规则的唯一定义。由 user-story-enhancer(WAY 6)和 benchmark-gap-story-writer(WAY 8)读取,以确保它们编写的故事在形态上保持一致,并使 WAY 6 能够重新评分 WAY 8 的输出。其本身并非一个工作流。

Download (.md)

📘如何使用这个技能

  1. 1
    复制技能内容·点击上方「Copy SKILL.md」复制全部内容,或 Download 下载到本地
  2. 2
    打开你的 AI 客户端·支持 Claude Code、Trae、Cursor、ChatGPT、DeepSeek、Kimi 等任意 AI 助手
  3. 3
    粘贴为系统提示/知识文件·Claude Code:放入 .claude/skills/ 目录;普通对话:作为首条消息发送并说「请严格按这份技能文档执行」
  4. 4
    直接提出你的需求·AI 会按技能定义的工作流、格式和约束来处理,无需再解释背景

💡 提示:技能生效后,每次对话只需一句需求,AI 会按 SKILL.md 的流程执行。

SKILL.md3107 chars
---
name: user-story-format
description: Reference only — the single definition of this project's user-story body (story, Gherkin ACs, test scenarios, Missing Information, DoD) and its AC/scenario rules. Read by user-story-enhancer (WAY 6) and benchmark-gap-story-writer (WAY 8) so stories they write stay identical in shape and WAY 6 can re-score WAY 8's output. Not a workflow on its own.
---

# user-story-format

Agents that write user stories `Read` this file and follow it exactly. When
the format changes, change it here only.

## Story body

```markdown
## User Story

As a <actor>, I want <goal> so that <business value>.

**Constraints:**
- <constraint>
- ...

---

## Acceptance Criteria

| # | Title | Priority |
|---|-------|----------|
| AC-01 | <title> | `must` |
| ... | | |

<details>
<summary>View full Gherkin scenarios</summary>

**AC-01 — <title>** `must`
- **Given** <precondition>
- **When** <action>
- **Then** <observable, assertable outcome>

...

</details>

---

## Test Scenarios

| Type | Description |
|------|-------------|
| `happy_path` | ... |
| `edge_case` | ... |
| `negative` | ... |
| `boundary` | ... |
| `security` | ... |
| `performance` | ... |

---

## Missing Information

- <open question that blocks writing tests>
- ...

---

## Definition of Done

- [ ] <measurable completion criterion>
- [ ] Regression tests generated by `test-writer` and passing
- ...
```

Writers put their own header block **above** `## User Story`:
- `user-story-enhancer` (WAY 6) titles the section `## Enhanced User Story` instead of `## User Story`, and appends the original body in a `<details><summary>Original story (preserved)</summary>` block after the DoD
- `benchmark-gap-story-writer` (WAY 8) adds `# US-<n> — <title>` plus the **Gap source / Target today / Priority · Effort** lines

Every story body ends with the Output Watermark footer from `CLAUDE.md`.

## Acceptance criteria rules
- Gherkin Given / When / Then
- Cover: main happy path, every variant mentioned, error flows, edge cases, and non-functional requirements if stated
- At least one negative/failure path per story
- "Then" must be concrete, observable, and assertable. Never "the system should work correctly"
- Priority: `must` for core flows, `should` for important variants, `could` for nice-to-haves
- Number from AC-01 sequentially. `test-writer` traces tests back to these IDs (`**Covers:** AC-01`), so never renumber existing ACs on a re-run. Append new ones instead

## Test scenario types
- `happy_path`: the primary success flow, no deviations
- `edge_case`: valid but extreme input or state
- `negative`: invalid input or unauthorized action
- `boundary`: values at or just beyond defined limits
- `security`: auth bypass, injection, data exposure attempts
- `performance`: load, concurrency, or latency under realistic conditions

## Missing Information
Questions that block writing tests, one per line. An empty section means
"nothing blocking", so write `- none` rather than deleting the heading.
`e2e-session` and `write-tests` stop and ask the user while any question here
is unanswered.
来源:skillsdirectory

评论0

登录后参与评论

还没有评论,来抢沙发吧