Skip to content

chatgpt prompt guide#2610

Open
sophiaqin-openai wants to merge 4 commits intomainfrom
chatgpt-prompt-guide
Open

chatgpt prompt guide#2610
sophiaqin-openai wants to merge 4 commits intomainfrom
chatgpt-prompt-guide

Conversation

@sophiaqin-openai
Copy link
Copy Markdown

Summary

Created a chatgpt prompt guide

For new content

When contributing new content, read through our contribution guidelines, and mark the following action items as completed:

  • I have added a new entry in registry.yaml (and, optionally, in authors.yaml) so that my content renders on the cookbook website.
  • I have conducted a self-review of my content based on the contribution guidelines:
    • Relevance: This content is related to building with OpenAI technologies and is useful to others.
    • Uniqueness: I have searched for related examples in the OpenAI Cookbook, and verified that my content offers new insights or unique information compared to existing documentation.
    • Spelling and Grammar: I have checked for spelling or grammatical mistakes.
    • Clarity: I have done a final read-through and verified that my submission is well-organized and easy to understand.
    • [ x Correctness: The information I include is correct and all of my code executes successfully.
    • Completeness: I have explained everything fully, including all necessary references and citations.

We will rate each of these areas on a scale from 1 to 4, and will only accept contributions that score 3 or higher on all areas. Refer to our contribution guidelines for more details.

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: f0b7fdd9c3

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread registry.yaml Outdated
- realtime

- title: ChatGPT Enterprise Prompting Guide
path: examples/chatgpt/chatgpt_prompt_guide.md
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Point registry path at the actual guide file

The new registry entry uses path: examples/chatgpt/chatgpt_prompt_guide.md, but this commit adds the document at examples/chatgpt/chatgpt_prompt_guide/chatgpt_prompt_guide.md; this mismatch means the publication workflow cannot locate the content, so the new guide will not render correctly on the cookbook site. Update the registry path to the real file location.

Useful? React with 👍 / 👎.

## 4. Write the prompt clearly
**Before you write the full prompt, take 30 seconds to outline the job in a simple structure. The easiest way is to use headings.**

All LLMs understand a language called “markdown” – the easiest aspect to master in markdown is that “#” is a label for “Header”. So in ChatGPT, the model understands that a line that starts with “#” is a section or header title in a document. It helps both you and ChatGPT quickly see what each part of the prompt is doing.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor nit: looks like there is an extra whitespace after "#"

* Acceptance criteria: How you’ll decide it’s correct. <br>
Examples: “contains 3 action items,” “matches our template,” “valid CSV that parses.”

## 5. Use ChatGPT to help you prompt (meta-prompting)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: make a reference to skills here too

Copy link
Copy Markdown
Contributor

@aaronwilkowitz-openai aaronwilkowitz-openai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 comment at the top, otherwise I'm ready to approve


Skills are small reusable add-ons that teach ChatGPT how to perform a specific task or follow a repeatable workflow. This Skill is designed to help apply the guidance in this guide more consistently, so you can get better results with less setup each time.

**To install it:**
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to be way clearer on how to install it. I would assume this audience is using ChatGPT. So I would walk them through: log into ChatGPT, open up your name in the bottom left, click on skills, click new skill, then pick "upload from your computer"

If someone is already advanced enough to use Codex, they probably don't need this guide as much, but you could have a separate section on how to install a skill in Codex if you wanted to

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adjusted to be more clear, let me know how it looks now!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants