name: agentic-structure description: 用于生产就绪开发的协作式编程框架。适用于启动功能、编写代码、处理安全/错误、添加注释、讨论需求或遇到知识缺口时。适用于所有开发任务,以创建清晰、安全、可维护的代码。 allowed-tools: [Read, Grep, Glob]
Agentic Structure
Agentic Structure 是一个旨在提高编程效率的提示框架。
本指南的核心是与用户协作创建项目和代码。 目标不是独立规划和推进所有事情,而是基于给定的想法和意见,通过相互反馈来取得更好的结果。 此外,文档包含良好和不良实践、代码风格规则以及库使用指南,应在整个开发过程中参考。
指南集合
这些是按需查阅的参考资料——只阅读与当前任务相关的内容;不要求预先通读所有内容。
DEVELOPMENT_PROCESS.md - 清晰、安全、生产就绪、可维护开发的原则 DISCUSSION_GUIDELINES.md - 何时以及如何进行讨论以达成一致决策 SECURITY_GUIDELINES.md - 用于秘密、哈希、身份验证和生产环境暴露的安全默认设置 CODING_STANDARDS.md - 关于清晰性、结构、重用和可维护性变更的编码规则 COMMENTING_GUIDELINES.md - 最小化、高信号注释规则和文档边界 ERROR_HANDLING.md - 错误处理原则、边界和安全意识的故障处理 KNOWLEDGE_SHARING.md - 处理信息缺口的知识请求协议
指南选择矩阵
使用此矩阵确定当前任务应查阅哪些指南:
| 您的任务 | 查阅这些指南 | 何时应用 |
|---|---|---|
| 启动任何功能实现 | DEVELOPMENT_PROCESS.md | 在编写任何代码之前 - 建立工作流程 |
| 用户请求不明确或模糊 | DISCUSSION_GUIDELINES.md | 无法确定单一正确解释时 |
| 需要超出训练数据的信息 | KNOWLEDGE_SHARING.md | 需要代码库中没有的API文档、规范或领域知识时 |
| 编写或修改函数/类 | CODING_STANDARDS.md | 创建或更改代码结构时 |
| 决定是否添加注释 | COMMENTING_GUIDELINES.md | 即将编写注释或用户请求文档时 |
| 实现错误处理 | ERROR_HANDLING.md | 添加 try-catch、错误检查或故障路径时 |
| 处理敏感数据或用户输入 | SECURITY_GUIDELINES.md | 处理身份验证、秘密、文件上传或外部数据时 |
| 存在多种有效实现方法 | DISCUSSION_GUIDELINES.md | 需要呈现具有权衡的选项时 |
| 不确定实现范围 | DEVELOPMENT_PROCESS.md | 需要确定什么符合“小步骤”时 |
| 代码变得深度嵌套或复杂 | CODING_STANDARDS.md | 超出嵌套限制或复杂度阈值时 |
| 错误需要上下文或转换 | ERROR_HANDLING.md | 决定如何处理捕获的异常时 |
指南冲突解决
当指南似乎冲突时,按以下优先级顺序应用:
1. SECURITY_GUIDELINES.md (最高优先级)
- 安全始终优先
- 如果安全指南与效率或简单性冲突,选择安全
- 示例:即使 CODING_STANDARDS 建议避免不必要的检查,SECURITY 也要求输入验证
2. DEVELOPMENT_PROCESS.md
- 流程约束和协作要求
- 示例:必须在非平凡决策前询问用户,即使 CODING_STANDARDS 建议了明确的方法
3. ERROR_HANDLING.md
- 正确性和适当的故障处理
- 示例:必须显式处理错误,即使 CODING_STANDARDS 建议更简单的代码
4. CODING_STANDARDS.md
- 代码质量和可维护性规则
- 示例:文件组织和命名约定
5. COMMENTING_GUIDELINES.md (冲突时最低优先级)
- 文档风格偏好
- 示例:即使 COMMENTING_GUIDELINES 不鼓励,也可能为安全假设添加注释
冲突解决示例
如果 CODING_STANDARDS 建议创建抽象,但 ERROR_HANDLING 要求每层都有显式错误类型,则遵循 ERROR_HANDLING - 创建显式错误处理,即使这意味着更多代码。
当不存在冲突时
大多数指南是互补的。一起应用所有相关指南:
- 使用 DEVELOPMENT_PROCESS 处理工作流程
- 使用 DISCUSSION_GUIDELINES 处理用户沟通
- 使用 CODING_STANDARDS 处理代码结构
- 使用 COMMENTING_GUIDELINES 处理文档决策
- 使用 ERROR_HANDLING 处理故障路径
- 使用 SECURITY_GUIDELINES 处理敏感操作
- 使用 KNOWLEDGE_SHARING 处理信息缺失时
有关每个指南的完整详细信息,请阅读完整文档。此技能提供快速参考——需要详细指导时请查阅完整指南。