mcpField
R
requirements-generator

requirements-generator

github.com/nextstage-brasil开发045 次安装4 天前更新
代码仓库

关于 requirements-generator

Requirements Generator 用于为指定的产品版本生成结构化的 requirements.md,面向项目规划工作流。它可根据通用或适用的技术栈配置整理需求文档。

主要功能

  1. 01生成版本专属的 requirements.md
  2. 02选择通用或技术栈专属配置
  3. 03将调研内容纳入非功能需求或验收标准
  4. 04适用时加入前端 UI/UX 需求
  5. 05明确数据模型、建表顺序和端点

适用场景

  1. 01起草新产品版本的需求
  2. 02根据已知技术栈调整需求
  3. 03将调研结果转化为验收标准
  4. 04记录前端及数据模型需求

安装

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

$npx skills add https://github.com/nextstage-brasil/skills --skill requirements-generator

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

包含的文件

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

evals/
evals.json
references/stacks/
generic.md
intelligent-saas.md
laravel-react.md

详细介绍

需求生成器

为 {product_root}/docs/versions/{version_san}/ 生成结构化的 requirements.md。

框架发现

请参阅 ../nextstage-harness/references/harness-discovery.md 和 ../nextstage-harness/references/artifact-layout.md。写入前,请创建 {product_root}/docs/versions/{version_san}/。

输入

  • 范围说明(可能已由 clarify-requirements 补充)
  • {product_root}、{version_san}
  • 可选:design-brief.md、技术栈配置、现有项目映射、编排器提供的网络调研

技术栈配置

技术栈已知时,从 references/stacks/ 加载一个配置:

配置适用情况
generic.md默认——与技术栈无关的结构
laravel-react.md检测到或已确认使用 Laravel + React 单体仓库
intelligent-saas.md后端 + 前端 + Agent API

除非配置文件或检测到的技术栈适用,否则不要提及特定框架的工具。

文档结构

仅生成 Markdown 文档(不添加对话式开场白):

## Main objective of the version:

{executive summary}

## Technology stack:

{confirmed stack — reference applicable rules when harness has them}

## UI/UX guidelines:

{from design-brief when frontend in scope — omit if backend-only}

## Data model and APIs:

{tables, FK order, key endpoints — source of truth for tasks}

## Feature grouping:

### Feature 001 - TITLE

**Precedence:** None | Feature NNN
**Layers:** Backend | Frontend | Infrastructure | Tests
**Detailed description:** ...

#### Acceptance criteria:

- [ ] ...

## Non-functional requirements (NFRs):

...

新项目的排序

对于全新项目,基础设施/设置功能应按技术栈配置中的顺序排在领域功能之前:基础设施 → 数据库 → 缓存/队列 → 后端模块 → 前端 → 测试。

语言

除非用户明确要求交付内容使用其他语言,否则使用英语。

规则

  • 仅在已确认的 {product_root} 下操作
  • 提供调研内容时,将其纳入非功能性需求或验收标准
  • 对于前端功能:纳入设计简报中的 UI/UX 部分;适用时,为视觉令牌添加验收标准
  • 数据模型部分至关重要——明确列出表的创建顺序和端点

集成

  • 生成后:通过 Gate 1(requirements_confirmed)——请参阅 ../nextstage-harness/references/gates.md
  • 下一步:通过 Gate 2 后执行 analyze-consistency

参考资料

文件适用情况
references/stacks/generic.md默认
references/stacks/laravel-react.mdLaravel/React 技术栈
references/stacks/intelligent-saas.mdAgent 增强型 SaaS

评论

支持 Markdown