mcpField
E
engineering-excellence

engineering-excellence

github.com/heyeddi-com开发086 次安装1 天前更新
代码仓库

关于 engineering-excellence

面向编码 Agent 的常驻技能，覆盖规划、实现、文档和工程审计，并强调复用与简化设计。项目产物统一放在 `.heyeddi/docs/` 下。

主要功能

  1. 01编码前计划检查
  2. 02工程文档初始化
  3. 03复用目录检查
  4. 04改动后工程审计
  5. 05工程决策记录

适用场景

  1. 01规划代码改动
  2. 02初始化工程文档
  3. 03审查架构或重构
  4. 04交接前审计改动

安装

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

$npx skills add https://github.com/heyeddi-com/heyeddi-skills --skill engineering-excellence

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

包含的文件

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

manifest.json
context/
ANTI_PATTERNS.md
EXAMPLES.md
PROSE_ANTI_SLOP.md
VOCABULARY.md
reference/
engineering-always-on.md
subagents.md
scripts/
_heyeddi_paths.py
_skill_cli.py
append_decision.py
audit_engineering.py
check_engineering_plan.py
init_engineering_docs.py
README.md

详细介绍

工程实践

可扩展的简单方案：做好文档记录，让下一个 Agent 无需过度构建或重复工作。

所有聊天只要计划或修改代码，就始终启用。请参阅 reference/engineering-always-on.md 和 hub docs/always-on-skills.md。

所有产物都放在 .heyeddi/docs/ 下：绝不放在仓库根目录。

适用场景

  • 每次聊天中提出实现计划或编辑代码时
  • 功能发布后：记录其工作原理
  • 添加抽象前：检查复用目录
  • 重构 / 架构评审：KISS、YAGNI、SOLID
  • 用户提出：“不要过度设计”“记录系统文档”“工程说明”

子 Agent（默认）

请参阅 reference/subagents.md。将 audit_engineering.py、check_engineering_plan.py 和文档初始化委派给 Task shell。主聊天负责解读结果并更新持续维护的文档。

流程

check_engineering_plan  → plan gate (docs + optional plan smells)
init_engineering_docs   → .heyeddi/docs/engineering/{architecture,reuse-catalog,decisions}.md
implement / refactor
audit_engineering       → .heyeddi/docs/engineering-audit-<date>.md (--check = errors fail)
append_decision         → ADR when trade-off is non-obvious

说明

  1. 计划门禁（每次聊天，在编码前）： python scripts/check_engineering_plan.py --project-root <root> --check（已有书面计划时添加 --plan-file）。
  2. 项目中的首次操作： python scripts/init_engineering_docs.py --project-root <root>
  3. 编码期间： 新建组件 / composable / 服务前，先阅读 reuse-catalog.md
  4. 完成有意义的更改后： 更新 architecture.md 模块图并添加复用条目
  5. 非显而易见的权衡： append_decision.py --title … --context … --decision …
  6. 变更门禁（每次聊天，在编辑后）： audit_engineering.py --check（错误会阻止通过；警告仅供参考）。仅当用户要求警告也阻止通过时，才使用 --strict。

原则（执行方式）

原则技能行为
KISS对过大的文件发出警告；文件极端过大时视为错误；优先采用扁平模块
YAGNI标记缺乏明确复用场景的抽象命名；新建 Factory/Manager 却未引用复用依据时，计划门禁会报错
DRY维护 reuse-catalog.md；UI 部分串联 @no-duplicate-ui
SOLID对臃肿的路由器发出警告；视图保持精简，服务承担更多职责
可测试性提醒视图缺少冒烟测试规格

.heyeddi/ 输出

路径用途
.heyeddi/docs/engineering/architecture.md系统图、数据流、边界
.heyeddi/docs/engineering/reuse-catalog.md已有内容：不要重复构建
.heyeddi/docs/engineering/decisions.md工程 ADR（不是设计日志）
.heyeddi/docs/engineering-audit-<date>.md特定时间点的审计报告

设计决策保留在 .heyeddi/design.md Decision log 中：不要混在一起。

串联

  • @heyeddi：任务含义不明确时，在此技能之前使用始终启用的路由器
  • @project-engineering：先搭建脚手架
  • @composable-patterns / @backend-type-bridger：架构说明就绪后使用
  • @pre-merge-gate：最终 CI；包含 audit_engineering --check

任务完成后：建议后续技能

完成此技能对应的用户请求后（不是每次工具调用或子 Agent 阶段结束后），建议接下来运行以下内容：

  1. 运行：

    python .agents/skills/heyeddi/scripts/suggest_next_skill.py --current-skill engineering-excellence --project-root .

    如果处理了特定路由，请添加 --route /path。

  2. 在最终回复中包含脚本的 ### Next step 区块。用户可将 Prompt 行复制到聊天中（例如：@visual-auditor review and fix /settings）。

如果刚完成变更门禁审计，请传入 --mode audit。

请参阅 @heyeddi → reference/next-skill-handoff.md。

评论

支持 Markdown