spec:requirements
11
总安装量
9
周安装量
#28462
全站排名
安装命令
npx skills add https://github.com/ikatsuba/skills --skill spec:requirements
Agent 安装分布
claude-code
7
antigravity
5
codex
5
opencode
5
gemini-cli
4
cursor
4
Skill 文档
Create Requirements Document
Creates a requirements document based on the task context and project. The user provides a spec name and task description, and this command generates a structured requirements document.
When to use
Use this skill when the user needs to:
- Create a new feature specification
- Document requirements for a task
- Generate a structured requirements document for planning
Instructions
Step 1: Gather Information
If the user hasn’t provided sufficient context, ask them:
- What is the name for this specification? (used for folder name, e.g., “user-authentication”, “payment-integration”)
- What is the main goal or purpose of this feature/task?
- What are the key user stories or use cases?
- Are there any specific technical constraints or requirements?
Step 2: Analyze the Codebase
Before writing requirements:
- Explore the relevant parts of the codebase to understand existing patterns
- Identify related services, components, or modules
- Note any dependencies or integrations that will be affected
Step 3: Create the Requirements Document
Create the document at .specs/<spec-name>/requirements.md with this structure:
# Requirements Document
## Introduction
[Brief description of what this feature/task aims to achieve and why it's needed]
## Glossary
[Define key terms used throughout the document, formatted as:]
- **Term**: Definition
## Requirements
### Requirement 1: [Requirement Name]
**User Story:** As a [role], I want [feature] so that [benefit].
#### Acceptance Criteria
1. THE [Component] SHALL [action/behavior]
2. WHEN [condition] THEN [Component] SHALL [action/behavior]
3. THE [Component] SHALL NOT [prohibited action]
[Continue with additional requirements following the same pattern]
Writing Guidelines
- Use SHALL for mandatory requirements – “THE system SHALL…”
- Use WHEN-THEN for conditional behavior – “WHEN user clicks submit THEN system SHALL…”
- Use SHALL NOT for prohibitions – “THE system SHALL NOT expose…”
- Be specific and testable – Each criterion should be verifiable
- Reference existing code patterns – Align with project conventions
- Keep requirements atomic – One requirement per item
- Prioritize user experience – Every user flow must feel natural. When related entities exist (e.g., category and subcategory), requirements MUST include inline/contextual creation â the user should never be forced to navigate away from the current page to create a dependent entity and then return. For example, if a form needs a parent entity that doesn’t exist yet, there must be a way to create it on the spot (inline dialog, quick-add in dropdown, etc.).
Step 4: Confirm with User
After creating the document, show the user:
- The location of the created file
- A summary of the requirements
- Ask if they want to make any changes
Arguments
This skill accepts an optional argument:
<args>– Can include the spec name and/or description. Parse it to extract:- Spec name (kebab-case, e.g., “user-auth” or “payment-flow”)
- Task description or context
If <args> is provided, use it to determine the spec name and context. If not sufficient, ask the user for clarification.