SuperAPI AI 工具集

coding-discipline

编程与开发

查看项目

更新于 10-15 23:42

技能介绍

用途:这是一份与语言无关的编码行为准则,用于约束 AI 代理在编写或修改代码时的行为,减少过度设计、顺带重构和盲目改动等常见问题。它属于提示/规范类资源,不依赖特定编程语言。

主要能力(四条原则):

  1. 先思考再编码:明确说明假设,不确定就问;存在多种理解时全部列出而非默默选择;更简单的方案要主动提出;遇到不清楚的地方停下来说明并提问。
  2. 简单优先:只写解决问题所需的最少代码,不加未被要求的功能、不为一次性代码做抽象、不添加未请求的“灵活性”或“可配置性”、不为不可能发生的场景写错误处理;若 200 行能压到 50 行就重写。
  3. 外科手术式改动:只碰必须改的地方,只清理自己造成的遗留;不“顺手改进”相邻代码、注释或格式,不重构没坏的东西,匹配现有风格;发现无关的死代码只提示不删除;自己改动导致失效的 import/变量/函数要移除,改动前就存在的死代码除非被要求否则不动。判断标准:每一行改动都应能直接追溯到用户请求。
  4. 目标驱动执行:把任务转成可验证目标,例如“加校验”转为“为非法输入写测试并让其通过”,“修 bug”转为“写一个能复现的测试再让它通过”,“重构 X”转为“确保重构前后测试都通过”;多步任务给出简短计划,每步标注验证方式。成功标准越强,越能独立循环推进。

使用方式:作为行为准则提示与编码任务一同使用即可;若追求速度而对琐碎任务使用,需自行判断取舍,因为该准则整体偏向谨慎而非速度。它还可配合同目录的 examples.md 查看每个原则的具体示例与常见错误。

适用场景:任何需要 AI 代理写代码、改代码的编程任务,尤其是希望产出干净、最小化 PR、避免顺带重构的场合。

限制:资料未提供具体安装方式、平台支持、价格或效果数据;其定位是行为准则而非可执行工具,实际效果取决于使用者的任务与模型。