前言
一分钟读论文系列。今日前端早读课文章由 @Unbug 授权分享。
@Unbug,Creator of Micropaper (https://unbug.github.io), CODELF (Github star 13k, https://unbug.github.io/codelf/), #MIHTool (Mentioned in Google I/O'13, https://mihtool.com)
正文从这开始～～
前哈佛大学计算机科学教授、谷歌工程主管 Matt Welsh 在美国计算机协会（ACM）的一个虚拟会议上说 “不要指望你的程序员职业生涯会一直持续下去，因为 AI 正在取代这个角色”。ChatGPT 近来让很多工程师感到很无力，仿佛任何努终将徒劳，但也有很多工程师看到了机会并尝试通过它成为 10X 工程师。美国田纳西州纳什维尔市范德堡大学的论文《ChatGPT Prompt Patterns for Improving Code Quality, Refactoring, Requirements Elicitation, and Software Design》 为软件工程提供了一个模式目录，全面总结了帮助工程师应用 ChatGPT 改进需求获取、快速原型制作、代码质量、重构和系统设计的提示模式的核心思想和 100 个提示要点。
系统需求和架构模式
这些模式可以帮助软件工程师在开发过程中更好地理解和验证系统需求和架构，并提高开发效率和质量。以下是每个模式提示语的要点：
需求模拟模式（Requirements Simulator Pattern）
这种模式允许利益相关者以交互方式探索依赖于软件的系统的需求，以确定是否正确捕获了某些功能。模拟输出应提供有关初始要求和为完成利益相关者试图在模拟中执行的任务而添加的新要求的更多详细信息。此模式的目标是帮助获取和分析软件需求的完整性。
我希望你扮演系统的角色
使用需求来指导你的行为
我会要求你做 X，你要告诉我在给定的需求下 X 是否 可能。
如果 X 是可能的，用需求来解释为什么。
如果我不能根据需求做 X，用 Y 格式写出需要的 缺失需求。
规范消歧模式（Specification Disambiguation Pattern）
这种及时模式目的是确保尽早发现并澄清任何潜在的沟通不畅或歧义的任何领域。
在这个范围内
考虑这些需求或规范
指出任何模糊或潜在的意外结果的地方
API 生成模式（API Generator Pattern）
此模式的目标是让开发人员能够快速探索多种可能的 API 设计，更早地形式化 API 设计，并为手动改进设计提供一个起点。
使用系统描述 X
为系统生成一个 API 规范
API 规范应该采用 Y 格式
API 模拟模式（API Simulator Pattern）
这种模式使 ChatGPT 从规范中模拟 API，从而使开发人员能够立即与 API 交互并通过 ChatGPT 运行的模拟来测试它。此外，ChatGPT 还可以通过合成示例请求以及提供使用指南和解释错误来帮助开发人员探索模拟 API。
根据规范 X 扮演描述的系统
我会以 Y 格式输入请求到 API 中
你要根据规范 X 以 Z 格式响应适当的回应
少样本代码示例生成模式（Few-shot Code Example Generation Pattern）
该模式的目标是让 ChatGPT 生成一组使用示例，这些示例稍后可以作为提示中的示例提供回 ChatGPT，以利用少样本学习。Few-shot learning 基于在提示中向 ChatGPT 提供一组有限的示例训练数据。就代码而言，少量示例是 ChatGPT 可以从中学习的代码的正确用法。在某些情况下，代码示例可以在更大的空间内传达代码的功能和用途。
我将给你提供系统 X
创建 N 个示例来展示使用系统 X 的方法
尽可能让示例覆盖完整
（可选）示例应该基于系统 X 的公共接口
（可选）示例应该关注 X
领域特定语言创建模式（DSL Creation Pattern）
这种模式使 ChatGPT 能够创建自己的领域特定语言 (DSL)，它和用户都可以利用这种语言来描述和操作系统概念，例如需求、部署方面、安全规则或模块方面的体系结构。然后，ChatGPT 可以为用户设计和描述 DSL。此外，可以存储 ChatGPT 生成的示例和描述，并在将来提示中使用，以将 DSL 重新引入 ChatGPT。此外，ChatGPT 生成的示例将作为未来提示的少量示例。
我想让你为 X 创建一个领域特定语言
语言的语法必须遵循以下约束条件
向我解释这种语言并提供一些例子
架构可能性模式（Architectural Possibilities Pattern）
这种模式生成了几种不同的架构供开发人员考虑，而开发人员几乎不需要付出任何努力。“架构” 可以是非常开放的，由开发人员向 ChatGPT 解释这个术语的含义。开发人员可能希望看到有关如何将代码布局到文件中、如何在模块之间或多层系统中的层之间执行通信的替代体系结构。该模式的目的是允许开发人员使用 ChatGPT 探索系统的任何这些架构方面。此外，开发人员可以通过添加更多约束或要求 ChatGPT 根据系统的不同方面（例如文件布局、模块、服务、通信模式、基础设施等）描述架构，以交互方式改进架构建议。
我正在开发一个用 X 为 Y 服务的软件系统
系统必须遵守这些约束条件
描述 N 种可能的架构方案
用 Q 来描述架构
变更请求模拟模式（Change Request Simulation Pattern）
这种模式帮助用户推断所提议的系统变更的复杂性，这可能与需求、体系结构、性能等相关。例如，这种模式帮助用户推断给定的变更可能对系统的某些方面产生什么影响， 例如哪些模块可能需要更改。当一组利益相关者需要讨论可能的需求变更并且 ChatGPT 可以作为变更范围和影响的（潜在）公正估计器时，这种模式特别有用。
我的软件系统架构是 X
系统必须遵守这些约束条件
我想让你模拟一个我将描述的对系统的变更
用 Q 来描述变更的影响
这是对我的系统的变更
代码质量和重构模式
这些模式可以帮助软件工程师在使用 ChatGPT 生成或修改代码时避免常见的问题和错误，并提高代码的可读性和可维护性。以下是每个模式提示语的要点：
代码聚类模式（Code Clustering Pattern）
该模式的目标是根据代码的特定属性将代码分离并聚集成函数、类等，例如分离纯代码和非纯代码、业务逻辑与数据库访问、HTTP 请求处理与业务逻辑。等等。该模式向 ChatGPT 定义了预期的集群属性，然后要求 ChatGPT 自动重构代码以实现所需的集群。该模式可用于确保 ChatGPT 生成的代码展示集群、重构人工代码以添加集群或审查代码。
在 X 范围内
我希望你以一种方式编写或重构代码，将具有 Y 属性的代码与具有 Z 属性的代码分开。
这些是具有 Y 属性的代码的例子。
这些是具有 Z 属性的代码的例子。
中间抽象模式（Intermediate Abstraction Pattern）
抽象和模块化是高质量可维护和可重用代码的基本组成部分。代码的编写方式应将内聚概念隔离到单独的函数或类中，以便可以在范围内隔离编辑。此外，在使用 ChatGPT 时，如果重构可以隔离到需要修改、替换或添加的单个函数，则重构现有代码会更容易。
如果你编写或重构具有 X 属性的代码
使用其他具有 Y 属性的代码
（可选）定义 X 属性
（可选）定义 Y 属性
在 X 和 Y 之间插入一个中间抽象 Z
（可选）抽象 Z 应该具有这些属性
原则性代码模式（Principled Code Pattern）
该模式的目标是使用众所周知的编码原则名称来描述所需的代码结构，而不必明确描述每个单独的设计规则。例如，一个组织可能希望确保他们的代码遵循 SOLID 设计原则。目标是快速确保生成、重构和审查的代码符合预期的设计或其他原则。
在这个范围内
生成、重构或创建符合命名原则 X 的代码
隐藏假设模式（Hidden Assumptions Pattern）
此模式的目标是让 ChatGPT 识别和描述在一段代码中所做的任何假设。该模式帮助用户识别这些假设或提醒他们他们可能已经忘记的假设。通过向用户展示代码中的关键假设，他们的 ChatGPT 可以帮助确保用户在与代码相关的决策中考虑到这些假设。
在这个范围内
列出这段代码所做的假设
（可选）估计改变这些假设或它们改变的可能性有多难
伪码重构模式（Pseudo-code Refactoring Pattern）
此模式的目标是让用户对算法、流程或代码的其他方面进行更细粒度的控制，同时不需要明确指定细节。该模式允许用户为生成或重构代码的一个或多个细节定义伪代码。ChatGPT 应调整输出以适应伪代码模板，同时确保代码正确且可运行。
重构这段代码
使其与这段伪码相匹配
尽可能地匹配伪码的结构
数据引导重构模式（Data-guided Refactoring Pattern）
此模式的目标是允许用户重构现有代码以使用具有新格式的数据。用户可以向 ChatGPT 提供新的格式模式并要求 ChatGPT 确定如何进行必要的更改，而不是指定确切的逻辑更改才能使用新格式。该模式有助于为合并数据格式更改这一常见任务自动进行代码重构
重构这段代码
使其输入、输出或存储数据格式为 X
提供一个或多个 X 的例子
References
ACM Chicago Feb 8 2023: Large Language Models and the End of Programming from Matt Welsh of Fixie.ai
关于本文
作者：@Unbug
原文：https://unbug.github.io/ChatGPT-Prompt-Patterns-for-Improving-Code-Quality,-Refactoring,-Requirements-Elicitation,-and-Software-Design/
这期前端早读课
对你有帮助，帮” 赞 “一下，
期待下一期，帮” 在看” 一下 。