Skip to content

Latest commit

 

History

8 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Real Engineering Prompt

填补最新 coding agent 与真实工程执行之间的最小行为差距。

一组简短、与工具无关的指令,用于约束技术写作、简单实现、局部修改、证据验证和歧义处理。

English

为什么创建这个项目

最新 coding agent 已经掌握编程语言、常见设计模式和标准工程术语。随着模型能力增强,有效提示词应更短,而不是更长。在长篇 system prompt 中重复模型已有知识只会增加噪声。本项目不是角色扮演 Prompt、通用编码手册或完整工程流程,也不声称能把 Agent 变成高级工程师。它只明确少量从反复实践中提炼、且已证明有效的工程行为约束:

  • 使用最低必要复杂度完整解决需求。
  • 只修改需求所必需的内容。
  • 用可观察结果定义成功,并用证据验证。
  • 从上下文消解低风险歧义,不默认停下来提问。
  • 准确表达技术信息,并区分事实与判断。

本仓库将这些约束整理为一个简短的指令文件。

使用方法

将 AGENTS.md 复制到目标仓库,或把其中内容加入 Agent 支持的指令载体。项目专用指令应与它共同使用;更具体的本地要求优先。

主要使用中文工作时,可以使用 AGENTS.zh-CN.md。两个文件具有相同的规范意图;跨语言维护以 AGENTS.md 为规范来源。

AGENTS.spare.md 存放默认未启用的候选规则,每条都说明了它防止的失败模式。当对应失败在实际工作中重复出现时,再把该条并入指令文件。

如果运行环境已经存在更强的同类规则,不要重复复制对应章节。本 Prompt 可以按章节使用。

设计原则

增加行为约束,不增加角色设定

每条指令必须防止一种可观察的失败。诸如“像世界级工程师一样工作”的角色描述没有定义动作或可验证结果。

采用最简单的完整方案

简单不等于不完整。如果任务依赖正确性、兼容性、错误处理、安全性或验证,这些内容仍属于需求。

保持局部修改

目标结果决定修改边界。必要的连带修改属于范围内;顺手重构、大范围格式化和推测性扩展不属于范围内。

用证据闭环

实现看起来合理不代表工作完成。先定义可观察的成功标准,再使用任务中实际可得的最强证据,例如测试、构建、运行行为、性能分析或基准测试。

只升级实质性歧义

提问前先检查代码、上下文和可用证据。如果不同解释会改变正确性、接口、数据、安全性或设计选择,则升级处理。低风险细节采用合理假设并继续执行。

使用受控技术语言

明确表达结论、原因、条件、动作、结果和限制。区分事实、假设、推断和建议。英文规范参考 ASD-STE100 Simplified Technical English 的核心原则;本项目与 ASD 无隶属关系,也不声称完整符合 ASD-STE100。

本项目有意省略的内容

  • 通用编程知识、语言规则和框架约定
  • 完整的软件开发流程或自主 Agent 编排器
  • 同一 Prompt 针对不同产品的重复版本
  • 安装器、命令行工具、编辑器扩展和运行时依赖
  • Prompt 可以替代测试、代码评审、项目约束或人类判断的主张

这些省略是有意设计。新增文本必须对应一种重复出现、且 Agent 无法仅从上下文可靠避免的失败。

相关项目与影响来源

本项目属于提升 coding-agent 行为可靠性的更广泛实践。相邻项目包括:

real-engineering-prompt 的目标更窄:维护可跨 Agent 和仓库使用的最小行为层。列出这些项目只表示影响来源和项目语境,不表示对方认可本项目。本仓库未复制这些项目的文本。

贡献

保持提案短小。说明它解决的失败模式、为什么代码或本地上下文无法可靠防止该失败,以及 Agent 如何执行并验证这条指令。不要添加通用建议或重复规则。

许可证

MIT

如果你觉得这套 Prompt 还不错,有点用,请帮忙点个 Star,感谢感谢 🙏

About

Bridge the minimal behavioral gap between the latest coding agents and real engineering execution.

Resources

Stars

4 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors