mcpField
P
project-init

project-init

github.com/vladm3105开发1763 次安装1 天前更新
代码仓库

关于 project-init

用于 SDD 流程新项目启动的脚手架技能,面向尚未建立文档结构的项目。它根据所选领域配置目录、索引文件和术语,并遵循项目适配配置。

主要功能

  1. 01选择项目领域
  2. 02创建分层文档目录
  3. 03应用领域术语映射
  4. 04生成各层索引文件
  5. 05按适配配置创建结构

适用场景

  1. 01为全新项目初始化 SDD 文档
  2. 02按业务领域配置文档术语
  3. 03依据启用层调整脚手架结构

安装

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

$npx skills add https://github.com/vladm3105/aidoc-flow-framework --skill project-init

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

详细介绍

project-init

用途

为 SDD 流程搭建全新项目框架:选择领域、创建 8 层文件夹结构和索引文件,并应用领域术语——这是工作流执行之前必须完成的一次性设置。

层级:跨层级实用工具(先于 BRD)。

何时使用

适用于:

  • 启动一个全新项目——尚无 docs/ 结构。
  • 尚未选择领域。

不适用于:

  • docs/01_BRD/ 等目录已存在——直接前往 ../doc-flow/SKILL.md。

行为

按顺序执行以下步骤;先创建文件夹,再创建文档。

1. 选择领域(首先)

询问项目面向哪个领域,并记录选择——该选择决定步骤 3 中应用的术语映射:

选项领域
1(默认)金融服务
2软件 / SaaS
3医疗保健
4电子商务
5IoT
6其他 / 通用
2. 文件夹结构

创建 8 个制品目录和支持文件夹:

mkdir -p docs/{01_BRD,02_PRD,03_EARS,04_BDD,05_ADR,06_SPEC,07_TDD,08_IPLAN}
mkdir -p docs/08_IPLAN/tmp plans
3. 领域配置

应用所选领域的术语映射(例如,金融领域: [RESOURCE_ITEM]→Position、[USER_ROLE]→Trader;软件领域: [RESOURCE_ITEM]→Resource、[USER_ROLE]→Account Admin;通用领域: [RESOURCE_ITEM]→Entity)。创建任何领域专属子目录。

4. 索引文件
touch docs/01_BRD/BRD-00_index.md docs/02_PRD/PRD-00_index.md \
      docs/03_EARS/EARS-00_index.md docs/04_BDD/BDD-00_index.md \
      docs/05_ADR/ADR-00_index.md docs/06_SPEC/SPEC-00_index.md \
      docs/07_TDD/TDD-00_index.md docs/08_IPLAN/IPLAN-00_index.yaml

之后创建的每个制品都必须填写文档控制部分 (名称、版本、日期、负责人、状态、修订历史)。

5. 验证

确认所有 8 个目录、索引文件、领域子目录和 plans/ 均已存在。如果有缺失项,重新执行相关步骤。

6. 移交

报告初始化已完成,并指引用户前往 ../doc-flow/SKILL.md 从 doc-brd 开始。模板位于 ${CLAUDE_PLUGIN_ROOT}/framework/layers/NN_<X>/;是否将其复制到项目中由用户自行决定。

适配

搭建项目框架前,读取项目适配配置文件 (.aidoc/profile.yaml)。遵循 active_layers:仅为启用的层创建结构——不要为已禁用的可跳过层搭建框架。忽略任何未知或不在适用范围内的键。 权威来源:${CLAUDE_PLUGIN_ROOT}/framework/governance/ADAPTATION.md。

相关资源

  • 下一步:../doc-flow/SKILL.md(从 doc-brd 开始)
  • 层级注册表:${CLAUDE_PLUGIN_ROOT}/framework/registry/LAYER_REGISTRY.yaml
  • 模板和 README:${CLAUDE_PLUGIN_ROOT}/framework/layers/NN_<X>/
  • 图表:../charts-flow/SKILL.md

评论

支持 Markdown