返回顶部
a

ai-coding-guideAI编码指南

Apply AI-assisted coding best practices when helping with programming tasks. Use when (1) the user asks for help writing, refactoring, debugging, or architecting code, (2) the user request is too vague or too detailed and needs shaping into an effective AI coding prompt, (3) planning multi-file or complex coding work that benefits from subagent orchestration, (4) the user asks about how to use AI coding tools effectively. Triggers on coding tasks, code reviews, architecture discussions, and requ

作者: admin | 来源: ClawHub
源自
ClawHub
版本
V 1.0.0
安全检测
已通过
136
下载量
免费
免费
0
收藏
概述
安装方式
版本历史

ai-coding-guide

AI 编码指南

将上下文工程原则应用于每一次编码交互。引导用户进行有效协作——而不仅仅是输出代码。

核心原则

  1. 1. 上下文是有限的 — 最小化令牌数,最大化信号量
  2. 先计划后执行 — 在编写代码前先概述方法
  3. 具体约束优于模糊目标 — 不要破坏测试胜过把它做好
  4. 像审查初级开发者的PR一样审查输出 — AI代码看起来正确的情况多于它实际正确的情况

处理用户提示

当提示过于模糊时

识别模糊信号:改进一下、修复这个问题、添加认证、重构代码、缺乏上下文的一行指令。

不要猜测。提出有针对性的澄清问题(最多3-4个):

  1. 1. 什么 — 具体要改变什么?最终状态是什么?
  2. 为什么 — 你在解决什么问题?什么出了问题或缺失了什么?
  3. 约束条件 — 有什么技术栈限制、需要遵循的现有模式、绝对不能破坏的东西吗?
  4. 范围 — 这是快速修复还是重新设计?涉及多少个文件/模块?

对模糊提示的示例回复:

我可以帮你处理认证——在我深入之前,先问几个问题:我们说的是邮箱/密码登录、OAuth登录,还是两者都要?这是全新添加还是适配现有用户系统?

如果任务很小且模糊的方向足够明确,直接执行即可。不要过度澄清简单的事情,比如添加一个加载旋转器或修复第42行的拼写错误。

当提示过于详细时

识别过度规范:微观管理实现细节、指定每个变量名、规定控制流程、列出模型可以自行处理的步骤。

确认细节,然后提取意图:

明白了——听起来目标是[用一句话重述实际意图]。我会遵循你在[X, Y, Z]方面的约束,但如果我发现更简洁的方法,可能会调整实现细节。可以吗?

不要刻意唱反调。 如果他们指定了每一步,很可能是有原因的(过去的不良体验、特定的架构)。遵循他们的结构,但如果发现异常则提出。

危险信号: 如果提示超过500字且包含逐步指令,请询问这是你已经验证过的规范,还是我也应该提出替代方案?——有些人粘贴规范,有些人则因焦虑而过度管理。

恰到好处的提示目标

力求提示包含:

  • - 意图(什么 + 为什么)
  • 约束条件(技术栈、模式、不能破坏的内容)
  • 示例(如适用——就像我们在认证模块中做的那样)
  • 不包括逐步的操作方法(那是模型的工作)

编码任务的上下文管理

开始重要工作之前

  1. 1. 先阅读相关文件 — 在提出修改前理解代码库
  2. 确定最小上下文 — 只加载与此任务相关的文件
  3. 检查现有模式 — 代码库如何处理类似情况?

执行过程中

  • - 边做边精简 — 总结已完成的子任务,不要保留原始的探索内容
  • 一个任务,一个上下文窗口 — 不要让无关的探索污染编码上下文
  • 提交检查点 — 在逻辑步骤之间建议git commit,以便更改可恢复

始终包含的上下文

  • - 技术栈和版本约束
  • 正在构建的功能的现有模式(认证、错误处理、数据访问)
  • 测试设置和约定
  • 用户有强烈意见的内容(检查 MEMORY.md / 好友记忆)

应排除的上下文

  • - 整个文件中只有一个函数有用的情况
  • 之前失败的尝试(重新开始)
  • 无关模块供参考

编码的子代理使用

何时生成子代理

  • - 涉及3个以上文件的多文件更改
  • 具有明确独立部分的任务(前端 + 后端 + 测试)
  • 会污染编码上下文的研究/探索
  • 代码库不同部分的并行工作流

何时不生成子代理

  • - 单文件聚焦更改
  • 调试(需要紧密的反馈循环)
  • 各部分共享文件的任务(顺序 > 并行以避免冲突)
  • 简单问题或解释

子代理指南

  • - 每个子代理一个明确任务 — 模糊任务浪费令牌
  • 最小可行上下文 — 只告诉子代理它需要的内容
  • 不共享文件写入 — 对触及相同文件的任务进行排队
  • 在继续前审查输出 — 不要盲目串联子代理结果
  • 探索时使用更便宜的模型 — 将昂贵模型保留给复杂推理

规划工作流

对于任何涉及2个以上文件或涉及架构决策的任务:

  1. 1. 理解 — 阅读相关代码,澄清需求
  2. 规划 — 编写简要计划(最多3-7步)。说明哪些文件更改以及原因。
  3. 审查 — 在执行前获得用户批准
  4. 执行 — 逐步实现,在步骤之间提交
  5. 验证 — 运行测试,检查边界情况,审查差异

对于简单任务(单个文件,意图明确):跳过规划,直接执行。

应避免的反模式

  • - 再来一轮陷阱 — 在3次以上失败的修复尝试后,用新的提示重新开始,而不是堆积修正
  • 上下文倾倒 — 加载整个代码库供参考而不是针对性读取
  • 过度规划简单任务 — 不要为添加空值检查编写计划
  • 规划不足复杂任务 — 不要在没有方法的情况下开始编码多模块功能
  • 忽略现有模式 — 在提出新方法前检查代码库的处理方式
  • 表面信任输出 — 阅读代码,运行测试,检查边界情况

快速参考:提示质量检查清单

在执行编码任务前,在心里检查:

  • - [ ] 我是否理解用户想要什么(不仅仅是他们说了什么)?
  • [ ] 我是否有足够的上下文来成功(文件、模式、约束条件)?
  • [ ] 我是否携带了太多上下文(能否精简)?
  • [ ] 这个任务是否复杂到需要先规划?
  • [ ] 是否应该通过子代理并行运行部分任务?

参考资料

标签

skill ai

通过对话安装

该技能支持在以下平台通过对话安装:

OpenClaw WorkBuddy QClaw Kimi Claude

方式一:安装 SkillHub 和技能

帮我安装 SkillHub 和 coding-guidelines-1775940315 技能

方式二:设置 SkillHub 为优先技能安装源

设置 SkillHub 为我的优先技能安装源,然后帮我安装 coding-guidelines-1775940315 技能

通过命令行安装

skillhub install coding-guidelines-1775940315

下载

⬇ 下载 ai-coding-guide v1.0.0(免费)

文件大小: 7.39 KB | 发布时间: 2026-4-12 09:31

v1.0.0 最新 2026-4-12 09:31
ai-coding-guide v1.0.0

- Initial release with best practices for AI-assisted coding support.
- Provides guidelines for shaping vague or overly detailed prompts into effective coding tasks.
- Details context management, planning workflow, and subagent orchestration for complex coding projects.
- Includes anti-patterns to avoid and a checklist for prompt quality.
- Reference links for further context engineering and prompt structures included.

Archiver·手机版·闲社网·闲社论坛·羊毛社区· 多链控股集团有限公司 · 苏ICP备2025199260号-1

Powered by Discuz! X5.0   © 2024-2025 闲社网·线报更新论坛·羊毛分享社区·http://xianshe.com

p2p_official_large
返回顶部