Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wuchangming/chatgpt-query-engineer-handbook
🤖️ChatGPT提问工程师 -- 开发指南
https://github.com/wuchangming/chatgpt-query-engineer-handbook
Last synced: about 2 months ago
JSON representation
🤖️ChatGPT提问工程师 -- 开发指南
- Host: GitHub
- URL: https://github.com/wuchangming/chatgpt-query-engineer-handbook
- Owner: wuchangming
- License: mit
- Created: 2022-12-07T17:15:31.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-07T15:37:34.000Z (over 1 year ago)
- Last Synced: 2024-05-28T01:01:20.841Z (4 months ago)
- Homepage:
- Size: 25.4 KB
- Stars: 702
- Watchers: 13
- Forks: 40
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🤖️ChatGPT 提问工程师 -- 开发指南
## ✨ 关于本指南
由于 `🤖️ChatGPT` 的回答是开放性和发散的，但对于具体的开发任务，更多是需要针对性的回答。为了提高 `ChatGPT提问工程师` 在与 `🤖️ChatGPT` 合作编程中的效率，而创建了这份文档来收集和整理常用的 `命令/问题`_（后面文中 `命令` 默认代指 `命令/问题`）_。
该指南旨在帮助 `ChatGPT提问工程师` 提高提问效率，欢迎 PR 👏👏👏 补充更多好问法。
_注意：本文档仅针对 `ChatGPT提问工程师` 开发工作的场景。使用 `🤖️ChatGPT` 应该是开放性的，与 `🤖️ChatGPT` 进行无限可能的思维碰撞才能给人类带来颠覆性的应用 🌟。_
## 📃 文档使用说明
- 命令稳定性：强 中 弱
- 由于 `🤖️ChatGPT` 的回答是发散的，命令稳定性代表符合期望的程度（主观性很大）。
- 默认值：强
- 尝试 10 次
- 强 `> 8次符合期望`
- 中 `> 5次符合期望`
- 弱 `> 2次符合期望`
- 明确处理的内容
- 例子 1 ：一般来说通过换行即可
```
优化代码
const hello = "🤖️ChatGPT";
```
- 例子 2 ：有时候 `🤖️ChatGPT` 无法区分需要处理的内容是什么，可以加 「」{} 之类的把内容圈起来。
```
优化文案
「该指南旨在帮助 `ChatGPT提问工程师` 提高提问效率」
```
- 例子 3 ：实在不行也可以再加些描述，所有命令都可以按这个模式去处理。
```
优化「」中的文案
「该指南旨在帮助 `ChatGPT提问工程师` 提高提问效率」
```
- ✨ 命令附加条件「重要概念」
- 所有命令都是可以添加任意附加条件「或者说附加需求」。附加条件可以非常抽象，这也是 `🤖️ChatGPT` 和传统 API 调用最大的不同，也是最颠覆的地方 🚀。
- 例子：
```
优化「」中的文案，扩充到 300 字
「该指南旨在帮助 `ChatGPT提问工程师` 提高提问效率」
```
- 上下文能力
- 由于 `🤖️ChatGPT` 具备上下文理解能力，可以对 `🤖️ChatGPT` 的回答和之前的所有对话内容直接进行提问。需要控制不要在连续提问中迷失最初的需求目标。
- 编程语言类型
- 什么都支持
- 人类语言类型
- 目前发现在涉及代码的场景，使用英语效果更好
## 📃 命令/问题列表
### 提前设置对话要求
---
- **设置回答问题的语言类型**
```
接下来的对话都用{中文/英文}回答我
```
- 备注：由于涉及代码的提问用英语比中文效果更好，但你可以要求 `🤖️ChatGPT` 用中文回答
- 例子
```
接下来的对话都用中文回答我
```
- **设置简写**
```
接下来的对话，如果我发送的内容是 {简写} ，我的意思是 {内容}
```
- 用途：很多时候，我们会有一些常用的内容，比如「重新回答这一问题」，这时可以用该命令设置简写，以后只需要发送简写就可以了。
- 例子
```
接下来的对话，如果我发送的内容是 re ，我的意思是 重新回答这一问题
```
### 通用
---
- **继续完成回答**
```
继续
```
- 用途：`🤖️ChatGPT` 回答太长的内容时经常会中断，可用该命令要求完成回答
### 需求分析
---
- **提取大段文案的中心思想**
```
中心思想
```
### 设计
---
- **优化文案**
```
优化文案
```
- **细化方案**
```
细化方案
```
### 编码
---
涉及代码的提问，使用英语的效果更好。但此时 `🤖️ChatGPT` 默认会以英语回答。
有两种方式让 `🤖️ChatGPT` 使用中文回答：
_方法一：提前设置对话要求 `接下来的对话都用中文回答我`_
_方法二：加一句到问题最后 `explain in Chinese`_
- **编写代码**
```
用 {TS/JS/编程语言} 实现：{描述需要实现的功能}
```
- 命令稳定性：弱（很大程度上取决于功能需求的描述）
- 这个是最强大的能力，也是最不可控。应该能找到更可靠的套路，比如：按照下面的接口实现代码逻辑，需要继续探索。
- 例子：
```
用 TS 实现：Vue 的双向绑定，但不能引入 Vue
```
- **正则表达式**
```
正则表达式：{描述需要实现的功能}
```
- 例子：
```
正则表达式：大于0的正整数
```
- **评审代码**
```
Review code and explain in Chinese
```
- **检查代码出错原因**
```
Check the cause of the code error and explain in Chinese
```
- **重构/优化代码**
- 重构代码
```
refactor the code
```
- 重构代码，以 vimdiff 格式展示更改的内容，并解释更改的内容
```
Refactor the code to present the changes in vimdiff format and explain the changes in Chinese
```
- **生成接口文档**
```
Generate markdown API Chinese documentation
```
- 命令稳定性：中
- 备注：由于每次生成都不一样，其实不太好在开发迭代中维护，希望能摸索出更好的方式
### 测试
---
- **添加单元测试**
```
Adding unit tests
```
- **生成 Mock 数据**
```
Generate data in json format
```
- 例子：
```
Generate data in json format
interface AComponent {
id: string;
name: string;
bComponent: BComponent;
}
interface BComponent {
id: string;
name: string;
}
```
## 📚 `ChatGPT提问工程师` 书籍推荐
[《学会提问》](https://book.douban.com/subject/35513147/)
## 📚 其他相关文档
[OpenAI 推出超神 ChatGPT 注册攻略来了
](https://www.v2ex.com/t/900126?p=2)
[ChatGPT 常见问题解答【官方/非官方版】](https://codechina.org/2022/12/chatgpt-faq/)
[GitHub Copilot Labs 【Copilot + ChatGPT】](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot-labs)