mcpField
N
ns-harness-bootstrap-brownfield

ns-harness-bootstrap-brownfield

github.com/nextstage-brasil开发069 次安装1 周前更新
代码仓库

关于 ns-harness-bootstrap-brownfield

用于在 SDD 规划前梳理现有代码库的 Agent 技能,输出紧凑的模块地图、差距和后续规划信息。它只读应用代码,并将架构规则作为引用而非重复内容。

主要功能

  1. 01检测前后端结构与项目布局
  2. 02按模块映射领域、文件与组件
  3. 03可选检查架构规则遵循情况
  4. 04生成压缩的棕地项目地图
  5. 05仅在指定上下文目录写报告

适用场景

  1. 01为缺少需求文档的旧项目启动 SDD 规划
  2. 02在需求生成前了解现有模块与差距
  3. 03更新已有的棕地项目地图

安装

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

$npx skills add https://github.com/nextstage-brasil/skills --skill ns-harness-bootstrap-brownfield

安装后在 Claude Code 中输入/ns-harness-bootstrap-brownfield确认已加载。

包含的文件

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

evals/
evals.json
references/
agent-dense.md
brownfield-map.template.md

详细介绍

存量项目引导

在 SDD 规划前,对现有产品进行架构发现。

输出采用面向 Agent 的密集格式(表格、计数、差距列表),而非面向读者的文章。参阅 references/agent-dense.md 和保存前的 ../ns-harness/references/agent-artifact-compress.md。

Harness 发现

参阅 ../ns-harness/references/harness-discovery.md。加载 {harness_root}/rules/*.md 中的规则。先阅读 architecture-rules.md。旧版规则:仅当 {harness_root} 不存在时,才使用 .cursor/rules/*.mdc。存在规范规则时,将发现结果与其对照;缺少规则时,检查仅供参考。不要将 constitution 规则栈复制到地图中——添加链接即可。

适用场景

  • “分析现有项目” / “存量项目引导”
  • 在有代码但没有 requirements.md 的代码库上首次进行 SDD 规划
  • 对旧版代码使用 ns-sdd-requirements-generator 之前

工作流

第 1 步 — 结构检测

在 {product_root} 下进行检测(旧版布局也需检查仓库根目录,并记录不一致之处):

后端信号: composer.json、artisan、模块化的 app/Modules/、docker-compose.yml、.env.example

前端信号: package.json、tsconfig.json、src/modules/、cypress/、打包工具配置

布局: backend/ + frontend/ 单体仓库,还是单体应用

第 2 步 — 模块映射

列出各领域:

  • 后端:各模块中的模块、控制器、模型、迁移
  • 前端:各模块中的页面、状态仓库、服务
第 3 步 — 规则遵循情况(可选)

存在 Harness 规则时,对照检查后端模块布局、多租户、前端模式和测试。每行标记 ✅ / ⚠️ / ❌。

没有 Harness 规则时,使用与技术栈无关的检查项。

第 4 步 — 报告

根据 references/brownfield-map.template.md 和 references/agent-dense.md,起草 {product_root}/docs/context/brownfield-map.md。

编写规则:

  • 仅使用表格 / 单行内容,不写概述段落。
  • 技术栈 = 指向 architecture-rules.md(+ 可选的一行差异说明)。
  • 差距 = 优先级表格;后续规划最多 3 条。

保存前(必需): 应用 ../ns-harness/references/agent-artifact-compress.md(极简模式),然后写入压缩后的文件。

第 5 步 — 呈现

仅在聊天中提供摘要(3–5 条:日期、关键差距、下一项技能)。不要将地图正文粘贴到聊天中。

关键规则

  • 只读——不修改代码
  • 仅在 {product_root}/docs/context/ 下生成报告
  • 将 brownfield-map.md 作为上下文传递给 ns-sdd-requirements-generator
  • 更新现有地图,而非重复创建
  • 绝不完整复制 architecture-rules.md 中的技术栈

相关技能

  • ns-harness-architecture-rules — constitution(技术栈 / 布局的事实来源)
  • ns-harness-codebase-reverse-spec — 提取业务行为(比引导更深入)
  • ns-sdd-requirements-generator — 引导后的下一步
  • ns-sdd-clarify-requirements — 需求范围仍模糊时使用

参考资料

文件时机
references/brownfield-map.template.md第 4 步骨架
references/agent-dense.md编写约束
../ns-harness/references/agent-artifact-compress.md保存前压缩(必需)

评论

支持 Markdown