提示词工程最佳实践:AI编程领域

针对AI编程中如何编写提示词,让AI准确按需求编程、避免“乱写”(即生成无关、错误或偏离需求的代码),以下是一套系统的方法论实用模板,能显著提升代码生成的准确性和可控性。

万能公式

又称指令工程,其核心在于设计精准提示词以引导模型准确捕捉用户需求。一个优秀的提示词能最大程度的引导大语言模型一步步思考,要有效防止AI幻觉。注意不要让ai来猜你的需求。

万能公式:身份/场景 + 任务(简述) + 要求(详细需求列表) + 输出 + [约束] + [示例]

示例:用 Python 实现快速排序,包含注释和测试用例。
身份:python程序员,任务:写一个快速排序算法,要求:注释和测试用例,输出:python代码

软件工程师(写代码→项目整合→测试)AI提示词整理

核心说明:所有提示词均内置强约束,避免AI脑补、扩展、乱写,覆盖「新建项目文件→按需求编写代码→项目整合完善→测试」全环节,直接复制替换占位符即可使用。

第一阶段:新建项目文件(初始化)

1.1 新建项目目录结构

你是专业软件工程师,帮我创建【________项目】的完整目录结构(适配________语言/框架),包含核心文件夹、配置文件、入口文件,符合行业规范。
要求:
1.  目录分层清晰(如:src、config、utils、test等)
2.  标注每个文件夹/文件的用途
3.  适配项目类型(后端/前端/全栈)
4.  不添加无关文件/文件夹

严格约束:不脑补、不扩展、不乱写、不省略。
只输出目录结构+简要用途,不额外解释、不添加无关内容。

1.2 初始化项目核心文件(入口/配置)

根据以下项目信息,编写初始化核心文件(入口文件+基础配置文件),代码可直接运行。
项目类型:________
语言/框架:________
核心用途:________
需初始化文件:________(如:main.js、app.py、application.yml等)

要求:
1.  代码规范,符合框架要求
2.  配置简洁,只保留基础必要配置
3.  入口文件可正常启动(无报错)
4.  不添加多余逻辑、不引入无关依赖

严格约束:不脑补、不扩展、不乱写、不省略。
不使用未定义的依赖/配置,只输出完整可运行代码,不额外解释。

第二阶段:按需求文档编写代码(核心环节)

2.1 按需求列表依次编写单个功能模块

你是专业软件工程师,严格按需求列表编写单个功能模块代码,贴合项目已有的目录结构和编码规范。
需求列表(单个功能):________
语言/框架:________
所属模块:________(如:用户模块、订单模块)
输入:________
输出:________
依赖文件/接口:________

要求:
1.  代码完整可直接运行,贴合项目目录结构
2.  注释规范(类、方法、关键逻辑需注释)
3.  处理异常和边界情况(如:参数为空、请求失败)
4.  不添加需求外的任何功能,不简化核心逻辑

严格约束:不脑补、不扩展、不乱写、不省略。
不使用未定义的变量、函数、库,只输出该功能模块的完整代码,不额外解释。

2.2 按现有代码风格续写功能代码

按照项目现有代码的风格、命名规范、结构分层,续写指定功能代码,完全贴合原有逻辑。
现有代码片段:________
需续写功能:________
语言/框架:________
要求:
1.  变量命名、缩进、注释风格与现有代码完全一致
2.  不改变原有逻辑,不优化、不重构现有代码
3.  续写内容完整可运行,衔接现有代码无报错

严格约束:不脑补、不扩展、不乱写、不省略。
只续写指定功能,不添加无关逻辑,不修改现有代码,不额外解释。

2.3 编写通用工具类/公共方法(复用性)

编写项目通用工具类/公共方法,适配当前项目的语言/框架,可复用、鲁棒性强,放入项目utils目录。
工具类/方法功能:________
语言/框架:________
参数:________
返回值:________
要求:
1.  参数校验完善,处理异常情况
2.  注释清晰(标注用途、参数含义、返回值说明)
3.  不依赖项目业务逻辑,可通用
4.  代码可直接运行,无语法错误

严格约束:不脑补、不扩展、不乱写、不省略。
不添加无关功能,不使用未定义的依赖,只输出工具类/公共方法完整代码。

2.4 编写接口/接口实现(后端专用)

编写项目接口及接口实现类,贴合项目架构,符合RESTful规范(如适用),可直接对接前端/其他模块。
接口功能:________
语言/框架:________
请求方式:________(GET/POST等)
请求参数:________
返回格式:________(JSON等)
所属模块:________

要求:
1.  接口设计规范,参数校验完善
2.  接口实现逻辑完整,无省略
3.  异常处理齐全(如:参数错误、业务异常)
4.  注释清晰,标注接口用途、参数、返回值

严格约束:不脑补、不扩展、不乱写、不省略。
不添加无关接口,不假设未定义的依赖/接口,只输出接口+实现类完整代码,不额外解释。

2.5 编写页面/组件(前端专用)

编写前端页面/组件,贴合项目技术栈,实现指定功能,样式、交互符合需求。
页面/组件功能:________
技术栈:________(HTML/CSS/JS/框架名称)
样式要求:________
交互要求:________
依赖组件/接口:________

要求:
1.  代码完整可运行,无语法错误
2.  样式统一,贴合项目整体风格
3.  交互逻辑完整,无省略(如:点击事件、数据渲染)
4.  代码结构清晰,注释规范

严格约束:不脑补、不扩展、不乱写、不省略。
不添加无关样式/交互,不引入未定义的组件/依赖,只输出页面/组件完整代码,不额外解释。

第三阶段:项目整合与完善

3.1 模块间对接整合(解决依赖、调用问题)

帮我整合项目各功能模块,解决模块间的依赖关系、调用冲突,确保所有模块可正常联动运行。
项目现有模块:________
模块间依赖关系:________
当前问题(如无则填“无”):________
语言/框架:________

要求:
1.  调整模块间调用逻辑,确保无冲突、无报错
2.  保留各模块原有功能,不修改核心逻辑
3.  整合后项目可正常启动,各模块联动正常
4.  标注修改的关键位置及原因

严格约束:不脑补、不扩展、不乱写、不省略。
不添加无关功能,只解决整合问题,输出整合后的关键代码(修改部分+完整联动代码),不额外解释。

3.2 项目代码优化(不改变功能,提升规范度)

对项目已编写的所有代码进行优化,**功能完全不变**,重点优化可读性、规范性、复用性,不做破坏性修改。
优化方向:________(如:代码规范、变量命名、注释补充、冗余代码删除)
项目代码片段/模块:________
语言/框架:________

要求:
1.  不改变原有业务逻辑,不影响模块联动
2.  优化后代码可直接运行,无报错
3.  贴合项目编码规范,提升代码可读性
4.  不添加任何新功能,不省略核心逻辑

严格约束:不脑补、不扩展、不乱写、不省略。
只做指定方向的优化,输出优化后的完整代码,不额外解释、不添加无关修改。

3.3 项目完善(补全缺失逻辑、异常处理)

完善项目代码,补全缺失的逻辑、异常处理、边界判断,确保项目运行稳定,无明显漏洞。
项目当前状态:________(如:已完成核心功能,缺少异常处理)
需完善的内容:________
语言/框架:________

要求:
1.  补全缺失逻辑,不遗漏核心需求
2.  完善异常处理(如:网络异常、数据异常、用户操作异常)
3.  补充边界判断(如:参数极值、空值、非法输入)
4.  不改变原有功能,不添加无关内容

严格约束:不脑补、不扩展、不乱写、不省略。
只补全指定内容,输出完善后的完整代码,不额外解释、不冗余。

3.4 项目整体校验(确保可正常启动、运行)

校验整个项目的完整性、可运行性,排查语法错误、依赖缺失、模块冲突等问题,给出可直接解决的方案。
项目名称:________
语言/框架:________
项目目录结构(简要):________
当前问题(如无则填“无”):________

要求:
1.  全面排查项目运行可能出现的问题(语法、依赖、联动)
2.  给出具体的解决步骤/修改代码,确保项目可正常启动
3.  不修改项目核心功能,不添加无关内容
4.  校验完成后,输出项目启动步骤及验证方法

严格约束:不脑补、不扩展、不乱写、不省略。
只排查问题、给出解决方案,不额外解释、不冗余。

第四阶段:项目测试(确保功能正常、无Bug)

4.1 单元测试用例编写(针对单个函数/方法)

为项目中的指定函数/方法编写完整单元测试用例,覆盖正常场景、边界场景、异常场景,可直接运行。
测试对象(函数/方法):________
语言/框架:________
测试工具:________(如:JUnit、pytest、Jest)
函数/方法代码:________

要求:
1.  测试用例覆盖全面,无遗漏关键场景
2.  测试代码可直接运行,能正常校验函数/方法功能
3.  标注每个测试用例的测试场景、预期结果
4.  不添加无关测试用例,不修改被测试函数/方法代码

严格约束:不脑补、不扩展、不乱写、不省略。
只输出单元测试用例完整代码,不额外解释、不冗余。

4.2 模块测试用例编写(针对单个功能模块)

为项目中的单个功能模块编写测试用例,验证模块功能是否符合需求,覆盖模块所有核心场景。
测试模块:________
模块功能:________
输入/输出要求:________
测试方式:________(手动测试/自动化测试)

要求:
1.  测试用例贴合需求,覆盖模块所有核心功能
2.  每个用例包含:用例名称、测试步骤、预期结果、实际结果(可留空)
3.  标注异常场景的测试用例,验证模块异常处理能力
4.  不添加无关测试场景,不偏离模块功能需求

严格约束:不脑补、不扩展、不乱写、不省略。
只输出模块测试用例,不额外解释、不冗余。

4.3 项目整体测试用例编写(全流程测试)

为整个项目编写全流程测试用例,验证项目各模块联动、整体功能是否符合需求,确保项目可正常交付。
项目核心功能:________
测试范围:________(如:用户注册→登录→下单全流程)
测试环境:________(如:本地环境、测试环境)

要求:
1.  测试用例覆盖项目全流程、核心功能,无遗漏
2.  每个用例包含:用例名称、测试步骤、预期结果、优先级
3.  覆盖正常流程、异常流程、边界场景
4.  测试用例可直接落地执行,无模糊描述

严格约束:不脑补、不扩展、不乱写、不省略。
只输出项目整体测试用例,不额外解释、不冗余。

4.4 Bug排查与修复(测试后优化)

根据测试用例执行结果,排查项目中出现的Bug,修复问题并验证,确保Bug彻底解决,不影响原有功能。
Bug描述:________
出现场景:________
相关代码片段:________
语言/框架:________

要求:
1.  先分析Bug原因,再给出修复方案
2.  修复后代码完整可运行,无新的Bug
3.  不改变原有功能,不添加无关修改
4.  输出修复后的完整代码+验证方法

严格约束:不脑补、不扩展、不乱写、不省略。
只修复指定Bug,不额外修改代码,不添加无关功能,不额外解释。

使用注意事项

  1. 所有提示词均需替换____中的占位符(如项目名称、语言框架、需求内容),替换后可直接复制给AI;

  2. 每个环节的提示词均内置强约束,无需额外添加约束语句,可有效避免AI乱写、脑补、扩展;

  3. 编写代码时,若项目已有固定编码规范,可在提示词中补充,确保AI输出符合项目要求;

  4. 整合、测试阶段,若有具体问题(如模块冲突、Bug详情),需详细填写,AI可更精准解决问题。

此处评论已关闭