first commit

This commit is contained in:
2026-08-14 23:41:57 +08:00
commit 086803a8dd
471 changed files with 91938 additions and 0 deletions
@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2026
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
@@ -0,0 +1,43 @@
# PRD Generator Skill
Generate structured Product Requirements Documents (PRD) for new features. Focused solely on producing a clear, implementable PRD — Issue decomposition and technical design are handled by separate skills.
## Features
- Asks 3-5 clarifying questions with lettered options for quick iteration
- Generates a well-structured PRD with user stories, numbered functional requirements, non-goals, success metrics, and more
- Enforces verifiable acceptance criteria (observable / testable / verifiable)
- Supports user review and adjustment before saving
- Saves output to `tasks/prd-[feature-name].md`
- Bilingual (Chinese & English) edge case handling
## Workflow
The PRD skill is the first step in a three-stage pipeline:
| Stage | Skill | Purpose |
|-------|-------|---------|
| 1. Requirements | `/prd` (this skill) | Define *what* to build |
| 2. Technical design (optional) | `/prd-to-spec` | Define *how* to build it |
| 3. Decomposition | `/to-issues` | Break into implementable tickets (GitHub / Local / Baidu iCafe) |
After a PRD is confirmed, run `/prd-to-spec` for complex features, then `/to-issues` — or go straight to `/to-issues`.
## Usage
Trigger with prompts like:
- "create a prd for..."
- "write prd for..."
- "写PRD"
- "需求文档"
- "需求分析"
## Files
- `SKILL.md` — Skill definition and instructions
- `test-prompts.json` — Test prompts for validation
## Attribution
This skill is adapted from [ralph/skills/prd](https://github.com/snarktank/ralph/tree/main/skills/prd).
@@ -0,0 +1,278 @@
---
name: prd
description: "Generate a Product Requirements Document (PRD) for a new feature. Use when planning a feature, starting a new project, or when asked to create a PRD. After PRD is confirmed, use /prd-to-spec (optional) for technical design, then /to-issues to create implementable tickets. Triggers on: create a prd, write prd for, plan this feature, requirements for, spec out, 写PRD, 需求文档, 需求分析, 规格说明."
user-invocable: true
---
# PRD Generator
Create detailed Product Requirements Documents that are clear, actionable, and suitable for implementation. After PRD is confirmed, use `/to-issues` to decompose it into Issues, and optionally `/prd-to-spec` for technical design before that.
---
## The Job
1. Receive a feature description from the user
2. Ask clarifying questions to cover key ambiguities — scale the count to complexity, not a fixed number (see Step 1)
3. Generate a structured PRD based on answers
4. **Present PRD to user for review** — ask "Please review the PRD. Let me know if any adjustments are needed, or reply OK to confirm."
5. Apply any adjustments, then save to `tasks/prd-[feature-name].md`
6. **Suggest next steps** (see Step 3)
**Important:** Do NOT start implementing. Just create the PRD.
---
## Step 1: Clarifying Questions
Ask only critical questions where the initial prompt is ambiguous. **Scale the number of questions to the feature's complexity — the goal is covering key ambiguities, not hitting a fixed count:**
- **Simple, well-scoped feature:** 2-3 questions
- **Typical feature:** 3-5 questions
- **Complex feature** (multiple user roles, cross-system integration, significant ambiguity): 6-8 questions
If a dimension is already unambiguous from the user's input, skip it — don't ask filler questions just to reach a number. Focus on:
- **Problem/Goal:** What problem does this solve?
- **Core Functionality:** What are the key actions?
- **Scope/Boundaries:** What should it NOT do?
- **Success Criteria:** How do we know it's done?
### Format Questions Like This:
```
1. What is the primary goal of this feature?
A. Improve user onboarding experience
B. Increase user retention
C. Reduce support burden
D. Other: [please specify]
2. Who is the target user?
A. New users only
B. Existing users only
C. All users
D. Admin users only
3. What is the scope?
A. Minimal viable version
B. Full-featured implementation
C. Just the backend/API
D. Just the UI
```
This lets users respond with "1A, 2C, 3B" for quick iteration. Remember to indent the options.
---
## Edge Cases & Fallback
| Scenario | Handling |
|----------|----------|
| User skips clarifying questions (e.g., replies "whatever", "just write it") | Fill with reasonable defaults, mark with `[Assumption]` in PRD, prompt user to confirm during review |
| User input is too vague (e.g., "add a feature") | Ask once for specifics; if still vague, infer from project context and mark assumptions |
| `tasks/` directory does not exist | Auto-create `tasks/` directory |
| feature-name is hard to extract from input | Ask the user directly: "Suggested PRD filename is prd-XXX.md, please confirm or modify" |
| User requests PRD changes after review | Apply changes and re-save without re-running the clarification flow |
| PRD content exceeds 500 lines | Suggest the user consider splitting into multiple sub-feature PRDs |
| User declines to proceed | Just save the PRD, user can run `/to-issues` later |
| Issue creation needed later | Suggest running `/to-issues` with the saved PRD file |
---
## Step 2: PRD Structure
Generate the PRD with these sections:
### 1. Introduction/Overview
Brief description of the feature and the problem it solves. Use plain language — avoid jargon or explain it. Assume the reader may be a junior developer or AI agent.
### 2. Goals
Specific, measurable objectives (bullet list).
### 3. User Stories
Each story needs:
- **Title:** Short descriptive name
- **Description:** "As a [user], I want [feature] so that [benefit]"
- **Acceptance Criteria:** Verifiable checklist of what "done" means
**Numbering rule:** US-001, US-002, US-003... (three digits, starting from 001). Each US should be independently implementable and small enough to complete within one focused agent session.
**Acceptance criteria self-check template:** Each criterion must satisfy at least one of the following, otherwise it is considered "vague" and must be rewritten:
- Observable: describes a specific UI state or API response (e.g., "button shows confirmation dialog")
- Testable: has clear input/output pairs (e.g., "entering an empty email shows a red warning")
- Verifiable: can be checked by tools (e.g., "Typecheck/lint passes")
- ❌ Bad example: "works correctly", "good user experience", "excellent performance" → these are unverifiable
**Format:**
```markdown
### US-001: [Title]
**Description:** As a [user], I want [feature] so that [benefit].
**Acceptance Criteria:**
- [ ] Specific verifiable criterion
- [ ] Another criterion
- [ ] Typecheck/lint passes
- [ ] **[UI stories only]** Verify in a browser (e.g., via the `run` skill)
```
**Important:**
- Acceptance criteria must be verifiable, not vague. "Works correctly" is bad. "Button shows confirmation dialog before deleting" is good.
- **For any story with UI changes:** Always include "Verify in a browser" as acceptance criteria (e.g., via the `run` skill). This ensures visual verification of frontend work.
### 4. Functional Requirements
Numbered list of specific functionalities:
- "FR-1: The system must allow users to..."
- "FR-2: When a user clicks X, the system must..."
**FR specification:** Each FR starts with `FR-N:` (N increments from 1), uses "system must / system shall" phrasing, and describes **one** specific behavior. Avoid combining multiple "and"-linked behaviors in a single FR.
### 5. Non-Goals (Out of Scope)
What this feature will NOT include. Critical for managing scope.
### 6. Design Considerations (Optional)
- UI/UX requirements
- Link to mockups if available
- Relevant existing components to reuse
### 7. Technical Considerations (Optional)
- Known constraints or dependencies
- Integration points with existing systems
- Performance requirements
### 8. Success Metrics
How will success be measured?
- "Reduce time to complete X by 50%"
- "Increase conversion rate by 10%"
### 9. Open Questions
Remaining questions or areas needing clarification.
---
## Output
- **Format:** Markdown (`.md`)
- **Location:** `tasks/`
- **Filename:** `prd-[feature-name].md` (kebab-case)
---
## Step 3: Next Steps
After the PRD is saved, suggest the user:
```
✅ PRD saved to tasks/prd-[feature-name].md
Next steps:
/prd-to-spec → Generate technical SPEC (optional — for complex features)
/to-issues → Decompose into Issues and create tickets
Or go straight to implementation:
/to-issues → Create Issues, then /goal to implement
```
If the user wants to proceed, invoke the corresponding skill.
---
## Example PRD
```markdown
# PRD: Task Priority System
## Introduction
Add priority levels to tasks so users can focus on what matters most. Tasks can be marked as high, medium, or low priority, with visual indicators and filtering to help users manage their workload effectively.
## Goals
- Allow assigning priority (high/medium/low) to any task
- Provide clear visual differentiation between priority levels
- Enable filtering and sorting by priority
- Default new tasks to medium priority
## User Stories
### US-001: Add priority field to database
**Description:** As a developer, I need to store task priority so it persists across sessions.
**Acceptance Criteria:**
- [ ] Add priority column to tasks table: 'high' | 'medium' | 'low' (default 'medium')
- [ ] Generate and run migration successfully
- [ ] Typecheck passes
### US-002: Display priority indicator on task cards
**Description:** As a user, I want to see task priority at a glance so I know what needs attention first.
**Acceptance Criteria:**
- [ ] Each task card shows colored priority badge (red=high, yellow=medium, gray=low)
- [ ] Priority visible without hovering or clicking
- [ ] Typecheck passes
- [ ] Verify in a browser (e.g., via the `run` skill)
### US-003: Add priority selector to task edit
**Description:** As a user, I want to change a task's priority when editing it.
**Acceptance Criteria:**
- [ ] Priority dropdown in task edit modal
- [ ] Shows current priority as selected
- [ ] Saves immediately on selection change
- [ ] Typecheck passes
- [ ] Verify in a browser (e.g., via the `run` skill)
### US-004: Filter tasks by priority
**Description:** As a user, I want to filter the task list to see only high-priority items when I'm focused.
**Acceptance Criteria:**
- [ ] Filter dropdown with options: All | High | Medium | Low
- [ ] Filter persists in URL params
- [ ] Empty state message when no tasks match filter
- [ ] Typecheck passes
- [ ] Verify in a browser (e.g., via the `run` skill)
## Functional Requirements
- FR-1: Add `priority` field to tasks table ('high' | 'medium' | 'low', default 'medium')
- FR-2: Display colored priority badge on each task card
- FR-3: Include priority selector in task edit modal
- FR-4: Add priority filter dropdown to task list header
- FR-5: Sort by priority within each status column (high to medium to low)
## Non-Goals
- No priority-based notifications or reminders
- No automatic priority assignment based on due date
- No priority inheritance for subtasks
## Technical Considerations
- Reuse existing badge component with color variants
- Filter state managed via URL search params
- Priority stored in database, not computed
## Success Metrics
- Users can change priority in under 2 clicks
- High-priority tasks immediately visible at top of lists
- No regression in task list performance
## Open Questions
- Should priority affect task ordering within a column?
- Should we add keyboard shortcuts for priority changes?
```
---
## Checklist
Before saving the PRD:
- [ ] Asked clarifying questions with lettered options
- [ ] Incorporated user's answers
- [ ] User stories are small and specific
- [ ] Functional requirements are numbered and unambiguous
- [ ] Non-goals section defines clear boundaries
- [ ] Saved to `tasks/prd-[feature-name].md`
- [ ] Suggested next steps: `/prd-to-spec` (optional) and `/to-issues`
@@ -0,0 +1,27 @@
[
{
"id": 1,
"prompt": "帮我写一个用户登录功能的PRD",
"expected": "应先询问3-5个澄清问题(登录方式、目标用户、安全要求等),用户回答后生成结构化PRD,包含用户故事、编号功能需求、非目标、验收标准等完整章节;结尾建议下一步运行 /prd-to-spec(可选)和 /to-issues"
},
{
"id": 2,
"prompt": "我需要给电商App加一个购物车功能,支持多规格商品",
"expected": "应识别'多规格'的歧义(SKU选择 vs 自定义规格),在澄清问题中覆盖;PRD中需体现规格选择、数量修改、价格联动等核心逻辑,验收标准需可验证"
},
{
"id": 3,
"prompt": "创建一个PRD,给我们的内部工具加批量导入功能",
"expected": "应区分内部工具场景(无普通C端用户),PRD应聚焦批量操作的错误处理、进度反馈、部分失败策略等企业场景关注点"
},
{
"id": 4,
"prompt": "随便写个功能的PRD吧",
"expected": "输入过于模糊时应先追问一次具体功能;若用户仍不明确(如回复'whatever'),用合理默认值填充并在PRD中用[Assumption]标注,在review阶段提示用户确认"
},
{
"id": 5,
"prompt": "给任务列表加一个优先级功能的PRD,包含前端展示",
"expected": "含UI改动的用户故事,验收标准必须包含'Verify in a browser (e.g., via the run skill)'一项;生成后展示PRD供用户review,确认后保存到 tasks/prd-*.md"
}
]