mcpField
A
architecture-aware-init

architecture-aware-init

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

关于 architecture-aware-init

面向架构尚未确定的新项目,提供结合在线研究、范式选择、模板定制和决策记录的初始化技能。结构化工作流将架构依据与项目目录和配置关联起来。

主要功能

  1. 01项目背景研究流程
  2. 02架构范式选择
  3. 03按范式定制模板
  4. 04创建架构决策记录
  5. 05用于自动化流程的 Python 辅助脚本

适用场景

  1. 01为新项目选择架构
  2. 02记录架构选择的理由
  3. 03按选定范式准备项目结构
  4. 04结合研究比较候选架构

安装

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

$npx skills add https://github.com/athola/claude-night-market --skill architecture-aware-init

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

包含的文件

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

modules/
paradigm-selection.md
research-flow.md
scaffold-generation.md
script-integration.md

详细介绍

感知架构的项目初始化

概述

将在线调研、架构范式选择、模板定制和决策记录整合到一个工作流中的项目初始化。当架构尚未确定,且选择需要说明理由时,请使用此技能。

何时使用此技能

  • 启动新项目,但不确定哪种架构最合适
  • 希望选择现代、符合行业标准的架构
  • 需要说明架构决策的理由
  • 希望根据选定的范式定制模板

当架构尚未确定时,使用此技能代替 project-init。 在 project-specification 之前使用,以确立架构基础。

必需的进度项

  1. arch-init:research-completed:已完成在线调研
  2. arch-init:paradigm-selected:已选择架构范式
  3. arch-init:templates-customized:已根据范式调整模板
  4. arch-init:decision-recorded:已创建 ADR

5 步工作流

步骤 1-2:收集背景信息,调研最佳实践

加载 modules/research-flow.md,获取完整的项目背景问卷和三级搜索策略。输出:为步骤 3 提供参考的综合简报。

步骤 3:选择架构范式

加载 modules/paradigm-selection.md,获取决策矩阵(团队规模与领域复杂度的对应关系)以及特殊情况的覆盖规则(流式处理、无服务器、微内核等)。有两种方式:

  • 使用 archetypes:architecture-paradigms 技能进行引导式探索。
  • 直接使用矩阵快速获取建议。
步骤 4-5:定制模板并记录决策

加载 modules/scaffold-generation.md,获取特定于范式的目录布局(其中展示了 Functional Core / Hexagonal / Microservices;其他范式则交由相应的 archetypes:architecture-paradigm-{name} 技能处理)和 ADR 模板。

输出:初始化包

完成工作流后,项目将包含:

  1. 与所选架构相匹配的目录结构
  2. 体现该范式的配置(测试布局、工具、依赖提示)
  3. 说明选择该范式原因的 ADR
  4. 指向相关范式技能的链接,为后续实现提供指导
  5. 步骤 2 中类似真实项目的参考资料

脚本集成

默认采用上述交互式工作流。如需自动化,请加载 modules/script-integration.md,查看 plugins/attune/scripts/ 下的三个 Python 辅助程序(架构调研器、模板定制器、完整交互流程)以及库式导入示例。

与现有命令的集成

此技能通过在脚手架搭建前添加架构选择阶段,扩展 /attune:project-init:

# Standard initialization (no architecture decision)
/attune:project-init --lang python --name my-project

# Architecture-aware initialization
/attune:brainstorm                  # Explore project needs
Skill(architecture-aware-init)      # Select architecture
/attune:project-init --arch <paradigm> --name my-project

示例会话

用户:“我正在为金融科技应用创建一个 Python Web API。团队有 8 名开发人员,业务规则复杂,并且需要高安全性和审计追踪。”

  • 步骤 1 背景信息:Web API、领域复杂度极高、5-15 名工程师、安全性和可审计性要求。
  • 步骤 2 调研:搜索金融科技 API 模式、审计追踪架构、CQRS+ES Python 示例。
  • 步骤 3 选择:结合调研结果和决策矩阵,得出 CQRS + Event Sourcing。
  • 步骤 4 模板:命令处理器模块、查询处理器模块、事件存储、聚合模式、投影处理器。
  • 步骤 5 ADR:记录 CQRS/ES 为何适用(可审计性、复杂规则、合规要求)。

结果:项目已初始化,采用适合该范式的结构,并清晰说明了决策理由。

相关技能

  • Skill(archetypes:architecture-paradigms):范式目录
  • Skill(archetypes:architecture-paradigm-*):各范式的实现指导
  • Skill(attune:project-brainstorming):架构设计前的构思
  • Skill(attune:project-specification):选择范式后的需求

另请参阅

  • /attune:project-init:项目基本初始化
  • /attune:blueprint:选择开发范式后进行架构规划
  • plugins/archetypes/README.md:完整的开发范式参考

退出标准

  • 四项进度均已勾选: arch-init:research-completed、arch-init:paradigm-selected、 arch-init:templates-customized、arch-init:decision-recorded。
  • 初始化后的项目中存在一个 ADR 文件,说明选择该开发范式的原因,并引用第 2 步研究综述中的证据。
  • 项目目录结构与所选 archetypes:architecture-paradigm-* 技能规定的布局一致(通过列出已创建的目录进行验证)。
  • 如果研究后仍未确定开发范式,技能会展示排名前两位的候选方案及其权衡,并等待用户明确选择,而不是悄然采用默认方案。
  • 如果已进行研究,research.json 包含 preferred 和 avoid 列表,并通过 --research-file 传入;推荐理由中包含一条提及“research”的规则

评论

支持 Markdown