Skip to content

Commit

Permalink
Merge pull request #6 from Zhu-J-J/main
Browse files Browse the repository at this point in the history
add github aciton 、update readme
  • Loading branch information
Kevin Zhang authored Oct 11, 2023
2 parents bec1ca4 + 1a4280d commit 96532d7
Show file tree
Hide file tree
Showing 4 changed files with 107 additions and 16 deletions.
35 changes: 35 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Build GitBook

on:
push:
branches:
- main # 触发条件:当代码推送到 main 分支时触发

jobs:
build:
runs-on: ubuntu-latest # 使用最新版本的 Ubuntu

steps:
- name: Checkout code
uses: actions/checkout@v2 # 检出代码仓库

- name: Setup Node.js
uses: actions/setup-node@v2
with:
node-version: 10.24.1 # 指定 Node.js 版本

- name: Install GitBook
run: |
npm install -g gitbook-cli # 安装 GitBook CLI
gitbook install # 安装 GitBook 插件和依赖
- name: Build GitBook
run: |
gitbook build # 构建 GitBook 项目
# 如果需要生成静态 HTML 网站,可以使用 "gitbook build" 命令
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3 # 使用部署到 GitHub Pages 的 Action
with:
personal_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./_book # 需要发布的目录,这里是 GitBook 构建输出目录
66 changes: 52 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,50 @@
# 项目说明
# 项目介绍

## 项目格式
![](./image/logo.svg)

## 提示词工程

欢迎来到Promptskillbuilders,此项目旨在演示如何有效地使用提示词来与自然语言处理模型合作,以生成各种类型的文本内容(以岗位分类)。本仓库提供了一系列案例,展示了如何构建有效的提示词,以及如何从模型中获得最佳结果,为各个领域角色赋能。

提示词是与自然语言处理模型互动的有效方式。它们是一种简单而强大的工具,可用于生成各种类型的文本,如文章、对话、代码片段等。以下是使用提示词工程的优势:

### 1. 简化互动

使用提示词可以简化与模型的互动过程。相比于编写复杂的API请求,您只需提供一个简单的提示词或句子,模型就能够生成相应的文本。这降低了使用门槛,使更多人能够利用这一技术。

### 2. 控制生成内容

通过选择合适的提示词,您可以更精确地控制生成的内容。您可以指导模型生成特定主题、风格或语气的文本,从而满足特定需求。

### 3. 提高创造力

提示词工程有助于激发创造力。您可以使用它来生成创意文案、故事情节、艺术作品等,为各种应用增添趣味和独特性。

## 如何使用这个仓库

此仓库 `part3` 目录下包含了多个示例案例,展示了如何构建和使用提示词来生成生产资料。您可以按照以下步骤来开始使用它:

1. 查看示例:在本仓库中浏览示例文件夹,以了解各种提示词的用法和效果。

2. 克隆仓库:使用 `git clone` 命令克隆这个仓库到本地。

3. 运行示例:按照每个示例文件夹中的说明,运行相应的代码示例。您需要设置相应的API密钥和模型配置。

4. 自定义提示词:根据您的需求自定义提示词,并查看生成的文本输出。调整提示词可以让您更好地满足特定应用场景。

## 贡献和问题反馈

我们欢迎您的贡献和问题反馈。如果您有任何改进意见、新的示例案例或发现了问题,请提交问题报告或拉取请求,以帮助我们不断改进这个项目。

## 授权

本仓库采用 `木兰开放作品许可协议许可证` 授权,详情请参阅 [LICENSE](./LICENSE) 文件。

希望这个提示词工程能够帮助您更好地理解和利用自然语言处理模型,为各种应用场景生成有趣和有用的文本内容。如果您有任何疑问或建议,请随时联系我们。

## 项目说明

### 项目目录

* Part1:提示词工程的基础概念 MD 文档
* Part2: 提示词技术说明 MD 文档
Expand All @@ -9,41 +53,36 @@
* SUMMARY:整体项目的目录


## gitbook
### 调试

基于`gitbook`框架进行调试
基于`gitbook`框架进行封装

下载 `gitbook` , `gitbook` 默认是 3.2.3 版本,此版本只能通过 `nodeJS 10.x` 编译,版本过高会报错

报错如下:
首先需要下载 `gitbook` , `gitbook` 默认是 3.2.3 版本,此版本只能通过 `nodeJS 10.x` 编译代码,版本过高会报错:

```shell
TypeError: cb.apply is not a function
```
安装流程:

```shell

# 执行下载命令

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash

# source 环境此终端的环境变量

source ~/.nvm/nvm.sh

# 下载 node10 版本

nvm install 10

nvm use 10

```

## 调试

```shell
npm install gitbook -g
# 全局安装gitbook
npm install -g gitbook-cli
gitbook install

# 本地调试
gitbook serve
Expand All @@ -52,6 +91,5 @@ gitbook serve
gitbook build

#其他命令

gitbook -h
```
20 changes: 20 additions & 0 deletions image/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 0 additions & 2 deletions part3/software-engineering/test-engineer.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,12 @@
# prompt1:
假设你是软件测试工程师,现在你的任务是阅读```中给出的需求文档,然后梳理出测试场景列表。
需求名称:多集团功能需求文档
```
需求背景:
在私有化部署环境,在一套部署环境之上,可以在portal上开通多个租户(一般是服务于多个企业的多个品牌),这些租户之间功能和数据完全独立,这个就是多集团能力。
在portal统一新建集团,在portal侧,也可以进行用户账号管理,可以为每一个账号分配对应的集团,这里可以为账号分配一个集团,也可以分配多个集团.
需求内容:
portal新建了多个集团,不代表这些集团在CDP就可以直接使用,默认情况下进入CDP只有默认集团可用。如果希望更多集团可被使用,需要CDP开通多集团功能开关,且配置了哪些集团可用。通过CDP功能开关实现,针对CDP没有配置的集团,用户通过portal.访问客户数据平台时,会展示用户没有相户权限的界面。
如果一个用户拥有多个集团的访问权限,是可以在右上角进行集团切换的(也可以进行项目切换)。
```
用例生成要求:
a.生成的测试场景语句通顺,表达清楚,不同测试场景的语义一定不要重复
b。必须先使用多种用例设计方法生成高覆盖度的测试用例,不要错过任何需求细节,用例书写格式:"1.[等价类划分/边界值分析/错误推测/正交实验/或其他测试设计手段]测试:{},预期: {}"
Expand Down

0 comments on commit 96532d7

Please sign in to comment.