SuperAPI AI 工具集

software-design-principles

编程与开发

查看项目

更新于 10-15 20:32

技能介绍

用途:这是代码层面的工程规范速查文档(Markdown,无脚本),供流程类技能、智能体与开发者阅读参考,用于在提交或合并代码前对齐设计标准。更大范围的设计分别由同系列的架构设计技能(系统级)与 UI/UX 设计技能(体验级)覆盖。

主要能力:整理 SOLID 五项面向对象设计规则、DRY(每段逻辑只有一个归属地)、整洁代码(命名、函数形态、注释、错误边界)、横切关注点归属(认证、授权、能力解析、审计日志、限流、模式校验、策略配置各由哪一层负责),以及非功能需求基线(性能、可扩展性、安全、可观测性、可运维性、韧性)。另附横切关注点映射表,要求在推进/合并前为每项关注点明确层级与责任模块。

硬性规则:名称须能自解释设计意图;层依赖只能向内(HTTP -> service -> infrastructure,不可反向);每个横切关注点只有一个归属方,重复的认证/审计逻辑视为坏味道;禁止重复逻辑,写前先查找已有副本并抽取共享辅助;完成前核查非功能需求基线;重构不改变外部边界测试;禁止在导入期耦合可选构建产物,缺失时应清晰降级(如返回 503 "not built"),该点由 lakebase-tdd-imports-clean 约束。

使用方式:作为查阅资料被动读取,相关流程技能在评审、PLAN、REFACTOR 等阶段引用它;PR 按其分层架构与横切检查进行评审,发布以非功能需求基线为门禁。

限制:仅为文档,无可执行脚本;分层架构的具体内容位于架构类技能中(此处仅引用)。具体安装命令、平台与收费信息暂未提供。