SuperAPI AI Directory
Partner中文AI newsFavorites
Skillsprd-suite

prd-suite

Writing & research

View repository

Updated 10-15 22:11

About this skill

PRD Document Management

🆕 Natural Language Requirement Template Support

Supports quickly creating a PRD using a natural language requirement template:

  1. Requirement template file: Provides the requirement_template.md file, describing project requirements in natural language
  2. Intelligent extraction: AI automatically extracts structured information from natural language
  3. Four modes：
    • Use XMind file: Read the xmind file via XMind MCP to generate a PRD (recommended)
    • Use requirement template: Generate a complete PRD based on the requirement template file (completed in 1 round)
    • Hybrid mode: Requirement template + interactive supplementation of missing sections
    • Manual creation: Use an interactive process to collect information round by round

For detailed templates, see:templates/requirement_template.md

Directory Structure

prd-suite/
├── SKILL.md                      # 主入口
├── commands/                     # 子命令
│   ├── create.md                 # 创建 PRD 命令
│   ├── update.md                 # 更新 PRD 命令
│   └── delete.md                 # 删除 PRD 命令
├── templates/                    # 模板文件
│   ├── main_prd_template.md            # 主 PRD 模板
│   ├── module_prd_template.md          # 模块 PRD 模板
│   ├── requirement_template.md         # 需求模板
│   ├── xmind_content_template.md       # XMind 内容解析模板
│   ├── changelog_format.md             # CHANGELOG 格式
│   ├── format_guidelines.md            # 格式规范说明
│   ├── review_process.md               # 审核确认流程
│   └── module_level_selection.md       # 🆕 层级选择功能说明
├── config/                       # 配置文件
│   └── config.json               # 配置信息
└── scripts/                      # 辅助脚本
    ├── parser.js                 # 自然语言解析脚本
    ├── utils.js                  # 工具函数
    └── level_analyzer.js         # 🆕 XMind 层级分析器

Subcommands

create

  • Function: Create a new PRD document
  • Subcommands：
    • create main - Create the main PRD document
    • create module - Create a module PRD document
  • Description: Supports quick generation from natural language requirement templates, with intelligent inference to reduce repeated input
  • Path：commands/create.md

update

  • Function: Update an existing PRD document
  • Subcommands：
    • update main - Update the main PRD document
    • update module - Update a module PRD document
  • Description: Supports single-section updates, version management, and change records
  • Path：commands/update.md

delete

  • Function: Delete a PRD document
  • Subcommands：
    • delete module - Delete a module PRD document
  • Description: Safely delete a module PRD, automatically updating the index and changelog
  • Path：commands/delete.md

Configuration File

The configuration file is located at config/config.jsonand contains the following:

  • Basic skill information
  • Subcommand configuration
  • Template file paths
  • Variable definitions
  • Feature toggles

Template Files

The template files are located in the templates/ directory:

  • main_prd_template.md - Main PRD document template
  • module_prd_template.md - Module PRD document template
  • requirement_template.md - Natural language requirement template
  • xmind_content_template.md - XMind content parsing document template
  • changelog_format.md - CHANGELOG format specification
  • format_guidelines.md - Template format specification description
  • review_process.md - Review and confirmation process description
  • module_level_selection.md - 🆕 XMind hierarchy selection feature description

Helper Scripts

The helper scripts are located in the scripts/ directory:

  • parser.js - Natural language requirement parsing script
  • utils.js - Utility functions (date handling, file operations, etc.)
  • level_analyzer.js - 🆕 XMind hierarchy analyzer

📋 File Naming Rules

⚠️ Important Constraints

All PRD file names must strictly follow the rules below!

Main PRD Naming

  • Format：main_prd.md
  • Location：prd/ directory
  • Constraints: No project name prefix is allowed; it is fixed as main_prd.md

Module PRD Naming

  • Format：M{编号}_{模块名称}_prd.md
  • Location：prd/modules/ under the directory
  • Numbering rule: starts from M001 and increments (M001, M002, M003...)
  • Naming rule: use the Chinese module name
  • Example：
    • M001_用户管理_prd.md
    • M002_订单管理_prd.md
    • M003_商品管理_prd.md

Incorrect naming example

❌ 错误命名：
- 用户管理系统_main_prd.md    ← 不允许项目名称前缀
- main_prd_用户管理.md         ← 不允许项目名称后缀
- M01_用户管理_prd.md          ← 编号必须三位数字（M001）
- M001_user_management_prd.md  ← 名称必须使用中文
- M001_用户管理.md             ← 必须以 _prd.md 结尾

✅ 正确命名：
- main_prd.md                  ← 主 PRD 固定命名
- M001_用户管理_prd.md         ← 模块 PRD 标准命名

📋 Template format requirements

⚠️ Important notes

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 the templates/ directory, and content must be generated strictly according to the following templates:

  1. Main PRD template：templates/main_prd_template.md
    • Used to create the main PRD document
    • Contains 9 standard chapters
    • Must maintain chapter order, table format, and Mermaid diagram format
  2. Module PRD template：templates/module_prd_template.md
    • Used to create module PRD documents
    • Contains 11 standard chapters
    • Must maintain chapter order, table format, and Mermaid diagram format

Format requirements

When generating a PRD, you must:

  1. Strictly follow the template structure
    • Maintain the order and numbering of all chapters
    • Do not omit any required chapter
    • Do not add chapters not defined in the template
  2. Maintain format consistency
    • The table format must be consistent with the template
    • Mermaid diagram syntax must be correct
    • Heading levels must be correct
  3. Completely replace variables
    • All {{变量名}} must be replaced with actual content
    • Do not retain any unreplaced variable placeholders
  4. Format validation
    • After generation, you must check whether the format conforms to the template
    • Any format issues found must be corrected immediately

Interface layout diagram generation requirements (key focus of module PRD)

⚠️ Important: The interface layout diagram must be complete and at an appropriate level of granularity!

When generating the "5.3 Page Description and Interaction Details" chapter of the module PRD, you must ensure:

  1. Completeness

    • Generate an interface layout diagram for every page listed in 5.1
    • Do not omit any page
    • The core areas of each page must be displayed

  2. Appropriate granularity

    • It cannot be too rough (e.g., only drawing a large box labeled "Content Area")
    • Specific elements must be displayed:
      • Table: display column names and sample data rows
      • Form: display field names and input boxes
      • Button: display the button name
    • Use ┌ ─ ┐ │ └ ┘ and other characters to draw clear borders

  3. State display

    • If there are multiple states (empty state, normal state), they need to be displayed separately
    • Pop-ups and drawers need to be displayed with separate layouts

For detailed specifications, please refer to:templates/format_guidelines.md the "Interface Layout Diagram Format" chapter in

Format specification description

For detailed format specifications, please refer to:templates/format_guidelines.md

Core Features

1. Natural Language Requirements Template

  • Supports describing project requirements in natural language
  • AI automatically extracts structured information
  • Generate a PRD in 1 round

2. Intelligent inference mechanism

  • Automatically extract relevant information from the main PRD
  • Reduce repeated user input
  • Improve creation efficiency

3. Quick mode

  • Generate only core sections
  • Skip optional sections
  • Suitable for secondary modules

4. Version management

  • Supports semantic versioning
  • Automatically record change logs
  • Version upgrade process

🗺️ XMind file support

Feature description

Supports generating the main PRD directly from XMind mind map files:

  1. XMind MCP integration: Read and parse xmind files through the XMind MCP service
  2. Complete content parsing: Parse all node content, including titles, notes, tags, links, etc.
  3. Intelligent analysis and summarization: Based on all node content, analyze and think to summarize key information
  4. Intermediate document generation: Generate xmind_content.md content document for confirmation
  5. Hierarchy selection: 🆕 AI automatically analyzes the XMind structure and recommends the most suitable functional module hierarchy (new)
  6. Template format output: Generate the final document according to the main PRD template format

Usage conditions

  • The XMind MCP service must be available

Supported XMind MCP tools

  • mcp_XMind_list_xmind_directory: Scan xmind files in the XMind MCP configuration directory
  • mcp_XMind_read_xmind: Read and parse xmind files
  • mcp_XMind_extract_node: Extract specific nodes
  • mcp_XMind_search_nodes: Search node content

🆕 Functional module hierarchy selection (new)

After XMind content parsing is complete, AI automatically analyzes the XMind structure and provides three hierarchy selection methods:

Option Description Applicable scenario
1️⃣ Confirm AI recommendation AI automatically analyzes the number of nodes, naming conventions, etc., and recommends the most suitable hierarchy Unsure which level to choose, trust AI judgment
2️⃣ Extract by fixed hierarchy The user enters a hierarchy number (1-5), and all nodes at that level are extracted Clearly know the XMind structure and have specific needs
3️⃣ Manually specify module list The user manually enters a list of functional modules (number | name | description) The XMind structure is special, or full customization is required

AI recommendation logic：

  • Moderate number of nodes (prefer 5-12)
  • Node naming conforms to functional module naming conventions
  • Matches the granularity of the main PRD functional module list

Content extraction principles

When extracting PRD information from XMind mind maps, follow these principles:

  1. Holistic thinking and summarization: Do not mechanically extract by keywords; instead, first fully parse all node content, then comprehensively analyze and think to summarize key information
  2. Extract content：
    • Feature overview: What are the core features of the product/project, and what problems does it solve
    • Users (user roles): Who are the target users, and what roles are there
    • Goals: What are the goals of the product/project
    • Feature module list: Organize the feature modules (🆕 use the module list determined in the hierarchy selection step)
    • Business process: Summarize the core business process
  3. Do not extract content：
    • Non-functional requirements
    • Acceptance criteria
    • Project background
  4. Do not display node source: The summary content does not indicate "which node it was extracted from"

Process description

For the detailed process, please refer to:commands/create.md "Create main PRD detailed process using XMind file" (including the hierarchy selection step)

Workflow

Create main PRD process

  1. Mode selection: First let the user choose the creation mode

    • Use XMind file: Read the xmind file through XMind MCP to generate the PRD (recommended)
    • Use requirements template: Generate the PRD based on the requirements template file
    • Hybrid mode: Requirements template + interactive supplementation
    • Manual creation: Use the interactive process

  2. Condition validation: Validate the prerequisites according to the selected mode

    • XMind mode: Verify whether the XMind MCP service is available
    • Requirements template mode: Check whether the project directory has requirement_template.md
    • Hybrid mode: Check whether the project directory has requirement_template.md
    • Manual creation: No validation required, start directly

  3. Information collection: Collect the necessary information according to the mode

  4. Generate document: Generate the complete PRD document content (⚠️ do not create a file)

  5. Display content: Display the complete content for the user to view

  6. Pause and wait for review：⚠️ Must pause and wait for the user's review and confirmation

  7. Review confirmation: The user reviews the generated content

  8. Complete creation: After the review is passed, create the PRD file and update the relevant indexes

Create module PRD process

  1. Prerequisites: Check whether the main PRD exists
  2. Select module: Select the module to create from the module list in the main PRD
  3. Mode selection：
    • Quick mode: Automatically generate the complete content based on the main PRD and module information, then review and confirm
    • Q&A mode: Ask about the core business information chapter by chapter, provide reference information, generate chapter content, review the chapter, and repeat until completed
  4. Content generation: Generate the module PRD content according to the selected mode
  5. Review confirmation: The user reviews the generated content
  6. Complete creation: Create the module PRD file and update the relevant indexes

Update PRD process

  1. Select document: Select the PRD to update
  2. Select chapter: Select the chapter to update
  3. Information collection: Collect update information
  4. Generate content: Generate updated chapter content (⚠️ does not update the file)
  5. Display content: Display the updated content for the user to review
  6. Pause and wait for review：⚠️ Must pause and wait for user review confirmation
  7. Review confirmation: User reviews the generated content
  8. Version management: Handle version upgrade
  9. Complete update: After review approval, update the PRD file and related records

Delete PRD process

  1. Select module: Select the module PRD to delete
  2. Safety confirmation: Confirm the deletion operation
  3. Delete file: Delete the module PRD file
  4. Update index: Update PRD_INDEX.md
  5. Update changelog: Record the deletion operation
  6. Confirm completion: Confirm the deletion is complete to the user

⚠️ Review confirmation mechanism

All PRD creation and update operations must go through user review confirmation!

Review process (after optimization)

  1. Generate content: AI generates PRD content
  2. Display for review: Display the complete content for the user to review
  3. Pause and wait：⚠️ Must pause and wait for user review
  4. User selection：
    • ✅ Confirm write: Write directly to the file and output a brief completion notice (do not display the content again)
    • ✏️ Provide modification feedback: The user enters modification feedback, and after AI modifies it, display it again for review
    • 🔄 Regenerate: Regenerate the content and display it again for review
    • ❌ Cancel operation: Terminate the process without creating a file

Core optimization

  • Single display principle: After confirming the write, write the file directly and do not display the content a second time
  • Brief completion notice: Output only the file path and word count, not the complete content
  • Redisplay only when modified: Only when the user provides modification feedback should the modified content be displayed again

Completion notice format

✅ 主 PRD 已创建：prd/main_prd.md（约 3500 字）

or

✅ 模块 PRD 已创建：prd/modules/M001_用户管理_prd.md（约 2800 字）

Review option descriptions

  1. ✅ Confirm write
    • The user confirms the content is correct
    • Write directly to the file and update the index
    • Output a brief completion notice
  2. ✏️ Provide modification feedback
    • The user enters specific modification feedback
    • AI modifies the content according to the feedback
    • After modification, display it again and enter a new round of review
  3. 🔄 Regenerate
    • The user is dissatisfied with the overall content
    • AI regenerates the content
    • After regeneration, display it again for review
  4. ❌ Cancel operation
    • The user cancels this operation
    • Do not create or update any files
    • Terminate the process

For the detailed review process, please refer to:templates/review_process.md

Usage

Create main PRD

  1. Call prd-suite skill
  2. Select create main Command
  3. Select creation mode (XMind file, requirements template, hybrid mode, manual creation)
  4. Validate conditions and collect information according to the mode
  5. Review the generated content
  6. Complete creation

Create Module PRD

  1. Ensure the main PRD already exists
  2. Call prd-suite skill
  3. Select the create module command
  4. Select full mode or quick mode
  5. Review the generated content
  6. Complete creation

Update PRD

  1. Call prd-suite skill
  2. Select the update command
  3. Select the PRD and section to update
  4. Provide update information
  5. Review the generated content
  6. Handle version management
  7. Complete update

Delete Module PRD

  1. Call prd-suite skill
  2. Select the delete module command
  3. Select the module to delete
  4. Confirm deletion
  5. Complete deletion

Notes

  • Supports rapid generation from natural language requirements templates
  • Maintain backward compatibility
  • All changes will be recorded in CHANGELOG.md
  • Module PRDs will be automatically updated to PRD_INDEX.md
  • Supports version management and status management