claude-code-requirements-builder

GitHub
1.8k 174 简单 1 次阅读 今天MIT语言模型Agent插件
AI 解读 由 AI 自动生成,仅供参考

claude-code-requirements-builder 是一款专为 Claude Code 设计的智能需求收集系统,旨在将模糊的功能想法转化为严谨的技术文档。它解决了传统开发中需求描述不清、上下文缺失以及非技术人员难以准确表达技术细节的痛点。

该工具特别适合产品经理、设计师以及希望规范开发流程的开发者使用,用户无需具备深厚的代码知识即可参与需求定义。其核心亮点在于“代码感知”与“两阶段问答”机制:首先,AI 会自动分析现有代码库架构,提出 5 个高层上下文问题;随后基于代码分析结果,再提出 5 个针对性的专家级问题。所有问题均采用简单的“是/否”格式,若用户不确定可直接回复"idk",系统将智能启用最佳默认值。

完成问答后,claude-code-requirements-builder 会自动生成包含具体文件路径、技术模式及约束条件的完整需求规格说明书。通过这种渐进式的发现过程,它确保了最终文档既符合业务目标,又与技术现状高度契合,大幅提升了功能开发的准确性与效率。

使用场景

某电商初创团队的后端工程师需要在现有的 Node.js 项目中紧急添加“订单导出为 PDF"功能,但面对数万行遗留代码,他难以快速理清架构依赖。

没有 claude-code-requirements-builder 时

  • 盲目沟通成本高:工程师需花费数小时手动翻阅代码库寻找现有的导出服务位置,再与产品经理反复确认技术细节,效率极低。
  • 需求文档缺失上下文:传统需求文档往往只记录业务逻辑,缺乏具体的文件路径和代码模式参考,导致开发时频繁返工。
  • 非技术人员参与困难:产品经理因不懂代码结构,无法准确回答关于技术实现的问题,导致需求定义模糊不清。
  • 易偏离既有架构:在没有自动分析的情况下,新功能容易引入不一致的代码风格或重复造轮子,破坏系统稳定性。

使用 claude-code-requirements-builder 后

  • 智能引导式问答:工具先自动分析代码库,随后仅向用户提出简单的“是/否”问题(如“是否复用现有的 ExportService?”),极大降低了沟通门槛。
  • 生成带路径的精确规格:自动输出的需求文档直接包含具体文件路径(如 services/ExportService.ts)和现有代码模式,开发人员可直接对照编码。
  • 零代码知识门槛:产品经理无需了解技术细节,只需对工具生成的上下文感知问题回答"idk"或“是”,即可完成专业级需求定义。
  • 确保架构一致性:基于对代码库的深度扫描,工具强制新需求遵循现有架构规范,从源头避免了技术债务的产生。

claude-code-requirements-builder 通过将复杂的代码分析与简化的交互流程结合,让非技术人员也能协同产出具备工程落地性的高质量需求文档。

运行环境要求

操作系统
  • Linux
  • macOS
  • Windows
GPU

未说明

内存

未说明

依赖
notes该工具并非独立的 AI 模型,而是一套用于 Claude Code 的提示词命令和工作流系统。运行前提是用户已安装并配置好 Claude Code 环境。安装过程仅需克隆仓库并将命令文件复制到 ~/.claude/commands/ 或项目本地 .claude/commands/ 目录,无需安装额外的 Python 包、GPU 驱动或深度学习框架。
python未说明
claude-code-requirements-builder hero image

快速开始

Claude 需求收集系统

一个针对 Claude Code 的智能需求收集系统,通过自动化发现逐步构建上下文,提出简单的“是/否”问题,并生成全面的需求文档。

🎯 概述

该系统通过以下方式革新需求收集流程:

  • 代码库感知型提问:AI 首先分析您的代码,然后提出有针对性的问题
  • 简单“是/否”格式:所有问题均为“是/否”,并配有智能默认值——只需回答“不知道”即可使用默认值
  • 两阶段提问:先提出 5 个高层次问题以获取上下文,再在代码分析后提出 5 个专家级问题
  • 自动化文档生成:根据具体文件路径和模式生成全面的规格说明
  • 产品经理友好:无需任何编程知识即可回答问题

🚀 快速入门

# 开始为新功能收集需求
/requirements-start 添加用户头像上传功能

# 查看进度并继续
/requirements-status

# 查看当前需求详情
/requirements-current

# 列出所有需求
/requirements-list

# 结束当前需求收集
/requirements-end

# 当 AI 走偏时快速提醒
/remind

📁 仓库结构

claude-requirements/
├── commands/                     # Claude 命令定义
│   ├── requirements-start.md    # 开始新需求
│   ├── requirements-status.md   # 查看进度(别名:current)
│   ├── requirements-current.md  # 查看当前需求
│   ├── requirements-end.md      # 完成需求
│   ├── requirements-list.md     # 列出所有需求
│   └── requirements-remind.md   # 提醒 AI 遵守规则
│
├── requirements/                 # 需求文档存储
│   ├── .current-requirement     # 跟踪当前需求
│   ├── index.md                 # 所有需求摘要
│   └── YYYY-MM-DD-HHMM-name/   # 单个需求文件夹
│       ├── metadata.json        # 状态和进度跟踪
│       ├── 00-initial-request.md    # 用户原始请求
│       ├── 01-discovery-questions.md # 5 个上下文问题
│       ├── 02-discovery-answers.md   # 用户答案
│       ├── 03-context-findings.md    # AI 的代码分析
│       ├── 04-detail-questions.md    # 5 个专家问题
│       ├── 05-detail-answers.md      # 用户详细答案
│       └── 06-requirements-spec.md   # 最终需求规格
│
└── examples/                     # 示例需求

🔄 工作原理

第一阶段:初始设置与代码库分析

用户:/requirements-start 为报表添加导出功能

AI 分析整个代码库结构,以理解架构、技术栈和模式。

第二阶段:上下文发现问题

AI 提出 5 个“是/否”问题,以了解问题背景:

Q1:用户会通过可视化界面与该功能交互吗?
(未知时默认:是——大多数功能都有 UI 组件)

用户:是

Q2:该功能是否需要在移动设备上运行?
(未知时默认:是——移动优先是标准)

用户:不知道
AI:✓ 使用默认值:是

[继续完成全部 5 个问题,然后记录答案]

第三阶段:目标性上下文收集(自主进行)

AI 自主执行以下操作:

  • 根据发现的答案搜索特定文件
  • 阅读相关代码段
  • 详细分析类似功能
  • 记录技术约束和模式

第四阶段:专家级需求问题

在深入理解上下文后,AI 提出 5 个详细的“是/否”问题:

Q1:是否应使用 services/ExportService.ts 中的现有 ExportService?
(未知时默认:是——保持架构一致性)

用户:是

Q2:PDF 导出是否需要超出标准模板的自定义格式?
(未知时默认:否——标准模板已覆盖大多数用例)

用户:否

[继续完成全部 5 个问题,然后记录答案]

第五阶段:需求文档生成

生成全面的规格说明,包括:

  • 问题陈述和解决方案概述
  • 来自全部 10 个答案的功能性需求
  • 包含具体文件路径的技术要求
  • 应遵循的实现模式
  • 接受标准

📋 命令参考

/requirements-start [描述]

开始为新功能或变更收集需求。

示例:

/requirements-start 实现暗黑模式切换

/requirements-status/requirements-current

显示当前需求进度并继续收集。

输出:

📋 当前需求:暗黑模式切换
阶段:发现问题
进度:已回答 3/5 个问题

下一步:Q4:此功能是否应在不同设备间同步?

/requirements-end

完成当前需求,即使尚未完全填写。

选项:

  1. 根据现有信息生成规格说明
  2. 标记为未完成,留待后续处理
  3. 取消并删除

/requirements-list

显示所有需求及其状态。

输出:

✅ 完成:暗黑模式切换(可实施)
🔴 活动:用户通知(发现阶段已完成 3/5)
⚠️ 未完成:数据导出(3 天前暂停)

/remind/requirements-remind

提醒 AI 遵循需求收集规则。

当 AI 出现以下情况时使用:

  • 提出开放式问题
  • 开始编写代码
  • 一次性提出多个问题

🎯 特点

智能默认值

每个问题都包含基于以下内容的智能默认值:

  • 最佳实践
  • 代码库模式
  • 已发现的上下文

渐进式提问

  • 第一阶段:首先分析代码库结构
  • 第二阶段:面向产品经理的 5 个高层次问题
  • 第三阶段:自动深入研究相关代码
  • 第四阶段:基于对代码的理解提出的 5 个专家问题

自动文件管理

  • 所有文件自动生成
  • 进度跨会话跟踪
  • 可随时恢复

即刻集成

  • 与开发会话链接
  • 引用 PR 和提交记录
  • 可搜索的需求历史

💡 最佳实践

对于用户

  1. 明确具体:清晰的初始描述有助于 AI 提出更好的问题
  2. 善用默认值:回答“不知道”完全没问题——默认值经过深思熟虑
  3. 保持专注:若 AI 走偏,可使用 /remind
  4. 随时完成:不必强迫自己回答每个问题

对于需求

  1. 一次只处理一个功能:确保需求聚焦
  2. 从实现角度思考:考虑其他 AI 将如何使用这些需求
  3. 记录决策理由:为什么这么做与做什么同样重要
  4. 全面关联:将需求与会话和 PR 相关联

🔧 安装

  1. 克隆本仓库:
git clone https://github.com/rizethereum/claude-code-requirements-builder.git
  1. 将命令复制到您的项目中:
cp -r commands ~/.claude/commands/
# 或者仅用于特定项目
cp -r commands /your/project/.claude/commands/
  1. 创建需求目录:
mkdir -p requirements
touch requirements/.current-requirement
  1. 如有必要,将其加入 .gitignore
requirements/

📚 示例

功能开发

/requirements-start 添加用户头像上传功能
# AI 分析代码库结构
# 回答关于该功能的5个是非题
# AI 自主研究相关代码
# 回答5个专家级是非题
# 获取包含文件路径的全面需求文档

Bug 修复需求

/requirements-start 修复仪表盘性能问题
# 回答关于范围的问题
# AI 定位存在问题的组件
# 回答关于可接受解决方案的问题
# 获取针对性的修复需求

UI 优化

/requirements-start 改善移动端导航体验
# 回答关于当前问题的提问
# AI 分析现有导航
# 回答关于期望行为的提问
# 获取详细的UI需求文档

🤝 贡献指南

  1. Fork 本仓库
  2. 创建你的功能分支
  3. 添加新命令或改进现有命令
  4. 提交 Pull Request

贡献建议

  • 添加常见功能的需求模板
  • 创建需求验证命令
  • 构建需求到实现的跟踪机制
  • 增加多语言问题支持

📄 许可证

MIT 许可证 - 欢迎在你的项目中自由使用和修改。

🙏 致谢

@iannuttallclaude-sessions 项目启发,该项目率先提出了针对 Claude Code 的结构化会话管理概念。


请记住:今天制定良好的需求,就能避免明天的混乱!

相似工具推荐

openclaw

OpenClaw 是一款专为个人打造的本地化 AI 助手,旨在让你在自己的设备上拥有完全可控的智能伙伴。它打破了传统 AI 助手局限于特定网页或应用的束缚,能够直接接入你日常使用的各类通讯渠道,包括微信、WhatsApp、Telegram、Discord、iMessage 等数十种平台。无论你在哪个聊天软件中发送消息,OpenClaw 都能即时响应,甚至支持在 macOS、iOS 和 Android 设备上进行语音交互,并提供实时的画布渲染功能供你操控。 这款工具主要解决了用户对数据隐私、响应速度以及“始终在线”体验的需求。通过将 AI 部署在本地,用户无需依赖云端服务即可享受快速、私密的智能辅助,真正实现了“你的数据,你做主”。其独特的技术亮点在于强大的网关架构,将控制平面与核心助手分离,确保跨平台通信的流畅性与扩展性。 OpenClaw 非常适合希望构建个性化工作流的技术爱好者、开发者,以及注重隐私保护且不愿被单一生态绑定的普通用户。只要具备基础的终端操作能力(支持 macOS、Linux 及 Windows WSL2),即可通过简单的命令行引导完成部署。如果你渴望拥有一个懂你

349.3k|★★★☆☆|5天前
Agent开发框架图像

stable-diffusion-webui

stable-diffusion-webui 是一个基于 Gradio 构建的网页版操作界面,旨在让用户能够轻松地在本地运行和使用强大的 Stable Diffusion 图像生成模型。它解决了原始模型依赖命令行、操作门槛高且功能分散的痛点,将复杂的 AI 绘图流程整合进一个直观易用的图形化平台。 无论是希望快速上手的普通创作者、需要精细控制画面细节的设计师,还是想要深入探索模型潜力的开发者与研究人员,都能从中获益。其核心亮点在于极高的功能丰富度:不仅支持文生图、图生图、局部重绘(Inpainting)和外绘(Outpainting)等基础模式,还独创了注意力机制调整、提示词矩阵、负向提示词以及“高清修复”等高级功能。此外,它内置了 GFPGAN 和 CodeFormer 等人脸修复工具,支持多种神经网络放大算法,并允许用户通过插件系统无限扩展能力。即使是显存有限的设备,stable-diffusion-webui 也提供了相应的优化选项,让高质量的 AI 艺术创作变得触手可及。

162.1k|★★★☆☆|5天前
开发框架图像Agent

everything-claude-code

everything-claude-code 是一套专为 AI 编程助手(如 Claude Code、Codex、Cursor 等)打造的高性能优化系统。它不仅仅是一组配置文件,而是一个经过长期实战打磨的完整框架,旨在解决 AI 代理在实际开发中面临的效率低下、记忆丢失、安全隐患及缺乏持续学习能力等核心痛点。 通过引入技能模块化、直觉增强、记忆持久化机制以及内置的安全扫描功能,everything-claude-code 能显著提升 AI 在复杂任务中的表现,帮助开发者构建更稳定、更智能的生产级 AI 代理。其独特的“研究优先”开发理念和针对 Token 消耗的优化策略,使得模型响应更快、成本更低,同时有效防御潜在的攻击向量。 这套工具特别适合软件开发者、AI 研究人员以及希望深度定制 AI 工作流的技术团队使用。无论您是在构建大型代码库,还是需要 AI 协助进行安全审计与自动化测试,everything-claude-code 都能提供强大的底层支持。作为一个曾荣获 Anthropic 黑客大奖的开源项目,它融合了多语言支持与丰富的实战钩子(hooks),让 AI 真正成长为懂上

150k|★★☆☆☆|今天
开发框架Agent语言模型

ComfyUI

ComfyUI 是一款功能强大且高度模块化的视觉 AI 引擎,专为设计和执行复杂的 Stable Diffusion 图像生成流程而打造。它摒弃了传统的代码编写模式,采用直观的节点式流程图界面,让用户通过连接不同的功能模块即可构建个性化的生成管线。 这一设计巧妙解决了高级 AI 绘图工作流配置复杂、灵活性不足的痛点。用户无需具备编程背景,也能自由组合模型、调整参数并实时预览效果,轻松实现从基础文生图到多步骤高清修复等各类复杂任务。ComfyUI 拥有极佳的兼容性,不仅支持 Windows、macOS 和 Linux 全平台,还广泛适配 NVIDIA、AMD、Intel 及苹果 Silicon 等多种硬件架构,并率先支持 SDXL、Flux、SD3 等前沿模型。 无论是希望深入探索算法潜力的研究人员和开发者,还是追求极致创作自由度的设计师与资深 AI 绘画爱好者,ComfyUI 都能提供强大的支持。其独特的模块化架构允许社区不断扩展新功能,使其成为当前最灵活、生态最丰富的开源扩散模型工具之一,帮助用户将创意高效转化为现实。

108.3k|★★☆☆☆|今天
开发框架图像Agent

gemini-cli

gemini-cli 是一款由谷歌推出的开源 AI 命令行工具,它将强大的 Gemini 大模型能力直接集成到用户的终端环境中。对于习惯在命令行工作的开发者而言,它提供了一条从输入提示词到获取模型响应的最短路径,无需切换窗口即可享受智能辅助。 这款工具主要解决了开发过程中频繁上下文切换的痛点,让用户能在熟悉的终端界面内直接完成代码理解、生成、调试以及自动化运维任务。无论是查询大型代码库、根据草图生成应用,还是执行复杂的 Git 操作,gemini-cli 都能通过自然语言指令高效处理。 它特别适合广大软件工程师、DevOps 人员及技术研究人员使用。其核心亮点包括支持高达 100 万 token 的超长上下文窗口,具备出色的逻辑推理能力;内置 Google 搜索、文件操作及 Shell 命令执行等实用工具;更独特的是,它支持 MCP(模型上下文协议),允许用户灵活扩展自定义集成,连接如图像生成等外部能力。此外,个人谷歌账号即可享受免费的额度支持,且项目基于 Apache 2.0 协议完全开源,是提升终端工作效率的理想助手。

100.8k|★★☆☆☆|昨天
插件Agent图像

markitdown

MarkItDown 是一款由微软 AutoGen 团队打造的轻量级 Python 工具,专为将各类文件高效转换为 Markdown 格式而设计。它支持 PDF、Word、Excel、PPT、图片(含 OCR)、音频(含语音转录)、HTML 乃至 YouTube 链接等多种格式的解析,能够精准提取文档中的标题、列表、表格和链接等关键结构信息。 在人工智能应用日益普及的今天,大语言模型(LLM)虽擅长处理文本,却难以直接读取复杂的二进制办公文档。MarkItDown 恰好解决了这一痛点,它将非结构化或半结构化的文件转化为模型“原生理解”且 Token 效率极高的 Markdown 格式,成为连接本地文件与 AI 分析 pipeline 的理想桥梁。此外,它还提供了 MCP(模型上下文协议)服务器,可无缝集成到 Claude Desktop 等 LLM 应用中。 这款工具特别适合开发者、数据科学家及 AI 研究人员使用,尤其是那些需要构建文档检索增强生成(RAG)系统、进行批量文本分析或希望让 AI 助手直接“阅读”本地文件的用户。虽然生成的内容也具备一定可读性,但其核心优势在于为机器

93.4k|★★☆☆☆|4天前
插件开发框架