mcpField
P
prd-init

prd-init

github.com/guoxiangjie文档处理939 次安装29 周前更新
代码仓库

关于 prd-init

prd-init 是用于新项目的 PRD 文档包初始化 skill，适合需要建立产品需求文档结构的项目团队。它检测预设位置，并用模板创建基础目录和文件。

主要功能

  1. 01检测预设 PRD 路径
  2. 02创建文档包目录与基础文件
  3. 03提供 README、索引和变更日志模板
  4. 04支持相对路径与绝对路径

适用场景

  1. 01为新项目创建 PRD 文档包
  2. 02检查并选择已有 PRD 结构
  3. 03在指定位置生成初始文档

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/guoxiangjie/skills --skill prd-init

安装后在 Claude Code 中输入/prd-init确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

commands/
init.md
config/
config.json
scripts/
utils.js
templates/
CHANGELOG.md
PRD_INDEX.md
README.md

详细介绍

来自项目 README

PRD 文档包初始化

功能说明

此 skill 用于在新项目中快速初始化 PRD 文档包结构。

目录结构

prd-init/
├── SKILL.md          # 主入口
├── commands/         # 子命令
│   └── init.md       # 初始化命令
├── templates/        # 模板文件
│   ├── README.md     # README模板
│   ├── PRD_INDEX.md  # PRD索引模板
│   └── CHANGELOG.md  # 变更日志模板
├── config/           # 配置文件
│   └── config.json   # 配置信息
└── scripts/          # 辅助脚本
    └── utils.js      # 工具函数

子命令

init
  • 功能：初始化 PRD 文档包结构
  • 路径：commands/init.md
  • 描述：创建完整的 PRD 文档包目录结构和基础文件

配置文件

配置文件位于 config/config.json，包含以下内容：

  • 技能基本信息
  • 模板文件路径
  • 子命令配置
  • 默认命令设置
  • 变量定义

模板文件

模板文件位于 templates/ 目录：

  • README.md - 项目说明文档模板
  • PRD_INDEX.md - PRD模块总集索引模板
  • CHANGELOG.md - 版本变更日志模板

辅助脚本

辅助脚本位于 scripts/ 目录：

  • utils.js - 工具函数，包含日期处理、文件操作等通用功能

工作流程

  1. 检测现有结构：直接检测预设路径 ./prd/ 和 ./openspec/prd/，判断是否存在有效的 PRD 结构（文件夹存在 + README.md + PRD_INDEX.md + CHANGELOG.md）
  2. 检测命令：如果没有指定命令，默认执行 init 命令
  3. 执行命令：根据指定的命令执行相应的功能
  4. 使用模板：读取模板文件，替换变量生成最终文档
  5. 创建结构：在指定位置创建 PRD 文档包结构

使用方法

  1. 调用 prd-init skill
  2. 系统检测预设路径 ./prd/ 和 ./openspec/prd/，判断是否存在可用的 PRD 文档包
  3. 如果找到可用的 PRD 结构，询问是否使用现有结构或选择新位置
  4. 如需新建，按照提示输入目标位置
  5. 系统自动创建 PRD 文档包结构
  6. 完成后可以使用 prd-suite skill 生成具体内容

注意事项

  • 支持相对路径和绝对路径
  • 如果目标位置不存在，会自动创建
  • 所有文件使用 UTF-8 编码
  • 日期格式为 YYYY-MM-DD

评论

支持 Markdown