mcpField
P
prd-init

prd-init

github.com/guoxiangjieドキュメント939 回インストール29 週間前に更新
リポジトリ

prd-init について

prd-initは、新規プロジェクト向けにPRD文書一式を初期化するスキルです。既定の場所を確認し、テンプレートからディレクトリ構成と基本ファイルを作成します。

主な機能

  1. 01既定のPRDパスを確認
  2. 02文書一式の構成と基本ファイルを作成
  3. 03README・索引・変更履歴のテンプレート
  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

コメント