January 1, 2025
By: Kevin

AI标准问答模板

  1. BUG 问题标题
    1. 问题描述
    2. 环境信息
    3. 复现步骤
    4. 补充材料
    5. 初步分析
  2. feature功能开发模板
  3. 高效提示清单 🌟
    1. 日常开发任务
    2. 调试
    3. 文档
    4. 测试
    5. 依赖与包管理
    6. AI 任务
    7. 上下文与摘要
    8. 有趣与实验功能
    9. 从零开始

BUG 问题标题

问题描述

  • 清晰描述Bug的现象
  • 预期行为 vs 实际行为

环境信息

  • 操作系统: Windows 11
  • 浏览器/版本: Chrome 120
  • 代码版本: Git commit abc123

复现步骤

  1. 第一步操作
  2. 第二步操作
  3. 出现异常的步骤

补充材料

  • 前端截图:

  • 日志片段(用代码块包裹):

    2024-01-01 ERROR [MainThread] 异常堆栈...

初步分析

  • 我的假设:可能和XXX组件有关(代码)
  • 已尝试的调试方法:重启/清除缓存等

feature功能开发模板

  1. 功能概述

    • 用注释说明代码库的 核心架构 和 扩展点
    • 示例 :: 现有页面编辑器上,扩展新组件

  2. 明确需求

    • 功能 : 组件需要实现XXX功能
    • 约束 : 需兼容现有组件的(可拖拽, 基础属性数据结构等)
    • 示例 : 实现xxx, 可以参考必须使用现有的Rxxx方法

  3. 分段处理

    • 先让LLM生成 设计文档/伪代码/接口设计
    • 生成代码实现
    • 生成测试代码

高效提示清单 🌟

日常开发任务

  • // 重构 {指定文件}，把 {x} 转换为 {y}... 适用于任意语言与仓库的通用重构。

  • // 为项目补充测试套件... 在缺乏测试覆盖的仓库快速建立自动化测试。

  • // 为 {指定函数} 添加参数类型说明... 帮助代码库逐步明确类型。

  • // 为 {指定数据结构} 生成模拟数据... 用于 API、前端或测试重度场景。

  • // 将这些 CommonJS 模块转换为 ES Modules... * JavaScript / TypeScript 现代化改造。

  • // 把基于回调的代码改成 async/await... * 改进 js 或 C# 中的异步逻辑。

  • // 为此字典结构实现一个 Spec... 在 Clojure 中使用 Spec 或 Malli 进行结构化数据处理。

调试

  • // 帮我修复 {具体错误}... 定位运行时或构建错误的一键提示。

  • // 为什么 {这段代码} 很慢？ 查找循环、函数或查询的性能瓶颈。

  • // 追踪为什么此值是 undefined... 解决前后端中值缺失的问题。

  • // 诊断这个内存泄漏... 适用于长时间运行的服务端进程。

  • // 添加日志以便调试该问题... 当错误静默发生时自动插桩。

  • // 查找这段异步代码中的竞争条件 分析并发系统中的潜在竞态。

  • // 在此代码中插入打印语句以跟踪执行流程... 快速理解复杂脚本的执行路径。

文档

  • // 为此项目编写 README 在缺少项目概览时快速生成文档。

  • // 给这段代码添加注释 提升复杂逻辑的可维护性。

  • // 为此端点编写 API 文档适用于 REST 或 GraphQL 后端。

  • // 为此 clj/cljs 命名空间/函数生成文档字符串... 便于后续自动化文档生成。

测试

  • // 为此 API 端点添加集成测试 Ring、FastAPI、Spring等后端常用。

  • // 编写一个测试来模拟 fetch 覆盖浏览器端 fetch / axios 请求逻辑。

  • // 将此测试从 Mocha 迁移到 Jest JS 测试框架平滑升级。

  • // 为此函数生成基于属性的测试 适合逻辑密集型代码。

  • // 在此测试套件中模拟慢网环境 验证 Web / 移动端在弱网下的表现。

  • // 编写测试以确保此函数向后兼容 库或 SDK 维护者常见需求。

  • // 编写 Fixture 来模拟外部 API 调用... 为测试提供稳健的外部依赖隔离。

依赖与包管理

  • // 升级我的 Linter 并自动修复破坏性配置变动 JS/TS 代码库更新 ESLint / Prettier 配置。

  • // 展示 React 19 的变更日志 快速了解前端框架新特性。

  • // 哪些依赖可以安全删除？ 清理冗余或陈旧依赖。

  • // 检查这些包是否仍在维护 注重安全与长期活跃度的项目。

  • // 为仓库配置 Renovate / Dependabot 自动更新 在 CI/CD 流程中持续维护依赖版本。

AI 任务

  • // 分析此仓库并生成 3 个功能创意 适合早期或全新项目的灵感激发。

  • // 识别此文件中的技术债 快速发现凌乱或脆弱的代码区域。

  • // 查找跨文件的重复逻辑 在大型仓库中去除冗余实现。

  • // 对相关函数进行聚类并提出重构建议 优化 utils / helpers 的组织结构。

  • // 帮我划定此 Issue 的范围，以便解决 与 AI 协同处理真实问题。

  • // 将此函数提炼为可复用的插件/模块 组件化高复用逻辑。

  • // 重构此函数以便并行处理（例如使用 future 或 core.async）... 提升计算密集型任务的性能。

上下文与摘要

  • // 根据最近提交写一份状态更新 用于团队异步沟通或管理报告。

  • // 总结过去 7 天的所有变更 休假后迅速掌握项目动态。

有趣与实验功能

  • // 当 {某操作} 成功时添加彩带动画 前端应用提升用户愉悦度。

  • // 当 {某次构建} 完成时注入程序员笑话 为团队工具增添趣味。

  • // 构建一个可在终端运行的迷你 CLI 游戏 用于学习或社区互动。

  • // 为此 UI 添加暗黑模式彩蛋 设计驱动项目的隐藏惊喜。

从零开始

  • // 这个仓库在做什么？ 理清遗留代码库或快速上手新项目。

  • // 初始化一个启用 CORS 的 Ring 应用 Clojure Ring 项目起步模板。

  • // 使用 Turborepo 与 PNPM 搭建 Monorepo 多包 JS/TS 项目共享依赖管理。

  • // 创建一个 Chrome 扩展的启动模板 浏览器扩展开发快速开始。

Tags: LLM