prd-suite
Original:🇨🇳 Chinese
Translated
2 scriptsChecked / no sensitive code detected
PRD Document Management, provides creation and update functions for main PRD and module PRD. Supports quick generation using natural language requirement templates. Call when you need to create or update PRD documents.
2installs
Sourceguoxiangjie/skills
Added on
NPX Install
npx skill4agent add guoxiangjie/skills prd-suiteTags
Translated version includes tags in frontmatterSKILL.md Content (Chinese)
View Translation Comparison →PRD Document Management
🆕 Natural Language Requirement Template Support
Supports quick PRD creation using natural language requirement templates:
- Requirement Template File: Provide file to describe project requirements in natural language
requirement_template.md - Intelligent Extraction: AI automatically extracts structured information from natural language
- Four Modes:
- Use XMind File: Generate PRD by reading xmind file via XMind MCP (Recommended)
- Use Requirement Template: Generate complete PRD based on requirement template file (Completed in 1 round)
- Hybrid Mode: Requirement template + interactive supplement for missing chapters
- Manual Creation: Collect information step by step using interactive process
Detailed template see: templates/requirement_template.md
Directory Structure
prd-suite/
├── SKILL.md # Main Entry
├── commands/ # Subcommands
│ ├── create.md # Create PRD Command
│ ├── update.md # Update PRD Command
│ └── delete.md # Delete PRD Command
├── templates/ # Template Files
│ ├── main_prd_template.md # Main PRD Template
│ ├── module_prd_template.md # Module PRD Template
│ └── requirement_template.md # Requirement Template
├── config/ # Configuration Files
│ └── config.json # Configuration Information
└── scripts/ # Auxiliary Scripts
├── parser.js # Natural Language Parsing Script
└── utils.js # Utility FunctionsSubcommands
create
- Function: Create new PRD documents
- Subcommands:
- - Create main PRD document
create main - - Create module PRD document
create module
- Description: Supports quick generation with natural language requirement templates, intelligent inference reduces duplicate input
- Path:
commands/create.md
update
- Function: Update existing PRD documents
- Subcommands:
- - Update main PRD document
update main - - Update module PRD document
update module
- Description: Supports single chapter update, version management and change records
- Path:
commands/update.md
delete
- Function: Delete PRD documents
- Subcommands:
- - Delete module PRD document
delete module
- Description: Safely delete module PRD, automatically update index and change log
- Path:
commands/delete.md
Configuration Files
Configuration file is located at , which includes:
config/config.json- Basic skill information
- Subcommand configuration
- Template file paths
- Variable definitions
- Feature switches
Template Files
Template files are located in directory:
templates/- - Main PRD Document Template
main_prd_template.md - - Module PRD Document Template
module_prd_template.md - - Natural Language Requirement Template
requirement_template.md - - CHANGELOG Format Specification
changelog_format.md
Auxiliary Scripts
Auxiliary scripts are located in directory:
scripts/- - Natural Language Requirement Parsing Script
parser.js - - Utility Functions (date processing, file operations, etc.)
utils.js
📋 Template Format Requirements
⚠️ Important Note
All generated PRD documents must strictly follow the template format! This is a key requirement to ensure PRD quality and consistency.
Template Files
Template files are located in directory, content must be generated strictly according to the following templates:
templates/- Main PRD Template:
templates/main_prd_template.md- Used to create main PRD documents
- Contains 9 standard chapters
- Must maintain chapter order, table format, Mermaid chart format
- Module PRD Template:
templates/module_prd_template.md- Used to create module PRD documents
- Contains 11 standard chapters
- Must maintain chapter order, table format, Mermaid chart format
Format Requirements
When generating PRD, you must:
- Strictly follow template structure
- Maintain order and numbering of all chapters
- Do not miss any required chapters
- Do not add chapters not defined in the template
- Maintain format consistency
- Table format must match the template
- Mermaid chart syntax must be correct
- Title hierarchy must be correct
- Complete variable replacement
- All must be replaced with actual content
{{Variable Name}} - Do not retain any unreplaced variable placeholders
- All
- Format Verification
- Must check if format complies with template after generation
- Must correct any format issues immediately
Format Specification Description
Detailed format specification please refer to: templates/format_guidelines.md
Core Features
1. Natural Language Requirement Template
- Supports describing project requirements in natural language
- AI automatically extracts structured information
- Complete PRD generation in 1 round
2. Intelligent Inference Mechanism
- Automatically extract relevant information from main PRD
- Reduce duplicate input for users
- Improve creation efficiency
3. Quick Mode
- Only generate core chapters
- Skip optional chapters
- Suitable for secondary modules
4. Version Management
- Supports semantic versioning
- Automatically records change logs
- Version upgrade process
🗺️ XMind File Support
Function Description
Supports direct generation of main PRD from XMind mind map files:
- XMind MCP Integration: Read and parse xmind files via XMind MCP service
- Intelligent Content Extraction: Extract information required for PRD from mind map structure
- Intermediate Document Generation: Generate content document for confirmation
xmind_content.md - Template Format Output: Generate final document according to main PRD template format
Usage Conditions
- XMind MCP service must be available
Supported XMind MCP Tools
- : Scan xmind files in directory
mcp_XMind_list_xmind_directory - : Read and parse xmind files
mcp_XMind_read_xmind - : Extract specific nodes
mcp_XMind_extract_node - : Search node content
mcp_XMind_search_nodes
Process Description
Detailed process please refer to: "Detailed Process of Creating Main PRD Using XMind File" in commands/create.md
Workflow
Create Main PRD Process
-
Mode Selection: Let user select creation mode first
- Use XMind File: Generate PRD by reading xmind file via XMind MCP (Recommended)
- Use Requirement Template: Generate PRD based on requirement template file
- Hybrid Mode: Requirement template + interactive supplement
- Manual Creation: Use interactive process
-
Condition Verification: Verify preconditions according to selected mode
- XMind Mode: Verify if XMind MCP service is available
- Requirement Template Mode: Check if requirement_template.md exists in project directory
- Hybrid Mode: Check if requirement_template.md exists in project directory
- Manual Creation: No verification required, start directly
-
Information Collection: Collect necessary information according to mode
-
Generate Document: Generate complete PRD document content (⚠️ Do not create file)
-
Display Content: Display complete content for user to view
-
Pause for Review: ⚠️ Must pause and wait for user review confirmation
-
Review Confirmation: User reviews generated content
-
Complete Creation: Create PRD file and update relevant indexes after approval
Create Module PRD Process
- Precondition: Check if main PRD exists
- Select Module: Select module to create from main PRD module list
- Mode Selection:
- Quick Mode: Automatically generate complete content based on main PRD and module information, then review and confirm
- Q&A Mode: Ask core business information chapter by chapter, provide reference information, generate chapter content, chapter review, until completion
- Content Generation: Generate module PRD content according to selected mode
- Review Confirmation: User reviews generated content
- Complete Creation: Create module PRD file and update relevant indexes
Update PRD Process
- Select Document: Select PRD to update
- Select Chapter: Select chapter to update
- Information Collection: Collect update information
- Generate Content: Generate updated chapter content (⚠️ Do not update file)
- Display Content: Display updated content for user to view
- Pause for Review: ⚠️ Must pause and wait for user review confirmation
- Review Confirmation: User reviews generated content
- Version Management: Handle version upgrade
- Complete Update: Update PRD file and relevant records after approval
Delete PRD Process
- Select Module: Select module PRD to delete
- Safety Confirmation: Confirm deletion operation
- Delete File: Delete module PRD file
- Update Index: Update PRD_INDEX.md
- Update Change Log: Record deletion operation
- Confirm Completion: Confirm deletion completion to user
📝 CHANGELOG Record Specification
Core Principles
CHANGELOG itself has no version concept, it is just a change record file.
- CHANGELOG records changes by date
- Each change record is associated with specific PRD file and its version
- PRD files have their own version numbers (e.g. v1.0, v1.1)
Record Format
When updating PRD, must record before-and-after comparison in CHANGELOG.md:
markdown
## 2024-01-15
### 📄 e-commerce-platform_main_prd.md (v1.0 → v1.1)
**Change Overview**: Adjust functional requirements of user management module
#### Chapter 3 Functional Module List
| Item | Before Change | After Change | Reason for Change |
|--------|--------|--------|----------|
| User Login Method | Only supports account password login | Add WeChat, Alipay third-party login | Users feedback single login method |Detailed Specification
Complete CHANGELOG format specification please refer to: templates/changelog_format.md
⚠️ Review Confirmation Mechanism
All PRD creation and update operations must go through user review confirmation!
Review Process
- Generate Content: AI generates PRD content (⚠️ Do not create or update file)
- Display Content: Display complete content for user to view
- Pause for Review: ⚠️ Must pause and wait for user review
- User Selection:
- ✅ Approve: Continue with subsequent operations
- ✏️ Propose Modifications: User inputs specific modification suggestions, AI modifies content and displays for review again
- 🔄 Regenerate: User is unsatisfied with overall content, AI regenerates content and displays for review again
- ❌ Cancel Operation: Terminate process, do not create or update any files
- Execute Subsequent Steps: Perform subsequent operations (create file, update index, etc.) only after approval
Important Principles
- Review Before Execution: Do not create or update files before approval
- Must Pause for Waiting: AI cannot automatically skip review steps
- Support Iterative Modifications: Users can propose modification suggestions multiple times
- Provide Complete Options: Must provide four options: approve, modify, regenerate, cancel
Review Option Description
- ✅ Approve
- User confirms content is correct
- Continue with subsequent operations (create file, update index, etc.)
- ✏️ Propose Modifications
- User inputs specific modification suggestions
- AI modifies content according to suggestions
- Display modified content again for new round of review
- 🔄 Regenerate
- User is unsatisfied with overall content
- AI regenerates content
- Display regenerated content again for review
- ❌ Cancel Operation
- User cancels current operation
- Do not create or update any files
- Terminate process
Detailed review process description please refer to: templates/review_process.md
Usage Methods
Create Main PRD
- Call skill
prd-suite - Select command
create main - Select creation mode (XMind File, Requirement Template, Hybrid Mode, Manual Creation)
- Verify conditions and collect information according to mode
- Review generated content
- Complete creation
Create Module PRD
- Ensure main PRD exists
- Call skill
prd-suite - Select command
create module - Select complete mode or quick mode
- Review generated content
- Complete creation
Update PRD
- Call skill
prd-suite - Select command
update - Select PRD and chapter to update
- Provide update information
- Review generated content
- Handle version management
- Complete update
Delete Module PRD
- Call skill
prd-suite - Select command
delete module - Select module to delete
- Confirm deletion
- Complete deletion
Notes
- Supports quick generation with natural language requirement templates
- Maintain backward compatibility
- All changes are recorded in CHANGELOG.md
- Module PRD is automatically updated to PRD_INDEX.md
- Supports version management and status management