Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New Module: A Beginner's Guide to Prompt Engineering with GitHub Copilot #88

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
### YamlMime:ModuleUnit
uid: |
learn.a-beginner's-guide-to-prompt-engineering-with-github-copilot.introduction
title: |
introduction
metadata:
title: |
introduction
description: "TODO this field is for search engine optimization and is not user-visible; use 2-3 complete, grammatically correct sentences to describe the unit; include relevant search keywords."
ms.date: 7/11/2023
author: a-a-ron
ms.author: aastewar
ms.topic: interactive-tutorial
###########################################################################
###
### If your content is related to a product or service, apply one value from the either the ms.prod allowlist
### or the ms.service allowlist. You can’t use both ms.prod and ms.service.
###
### If your content isn't about a product or service, you can omit both ms.prod and ms.service.
###
### The list of approved ms.prod values is here: https://review.learn.microsoft.com/help/platform/metadata-taxonomies?branch=main#msprod
### The list of approved ms.service values is here: https://review.learn.microsoft.com/help/platform/metadata-taxonomies?branch=main#msservice
### If you need to request new values, follow the process here: https://review.learn.microsoft.com/en-us/help/platform/metadata-allowlist-requests?branch=main
ms.prod: TODO
ms.service: TODO
durationInMinutes: 1
content: |
[!include[](includes/1-introduction.md)]
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
### YamlMime:ModuleUnit
uid: |
learn.a-beginner's-guide-to-prompt-engineering-with-github-copilot.learning-content
title: |
learning-content
metadata:
title: |
learning-content
description: "TODO this field is for search engine optimization and is not user-visible; use 2-3 complete, grammatically correct sentences to describe the unit; include relevant search keywords."
ms.date: 7/11/2023
author: a-a-ron
ms.author: aastewar
ms.topic: interactive-tutorial
###########################################################################
###
### If your content is related to a product or service, apply one value from the either the ms.prod allowlist
### or the ms.service allowlist. You can’t use both ms.prod and ms.service.
###
### If your content isn't about a product or service, you can omit both ms.prod and ms.service.
###
### The list of approved ms.prod values is here: https://review.learn.microsoft.com/help/platform/metadata-taxonomies?branch=main#msprod
### The list of approved ms.service values is here: https://review.learn.microsoft.com/help/platform/metadata-taxonomies?branch=main#msservice
### If you need to request new values, follow the process here: https://review.learn.microsoft.com/en-us/help/platform/metadata-allowlist-requests?branch=main
ms.prod: TODO
ms.service: TODO
durationInMinutes: 1
content: |
[!include[](includes/2-learning-content.md)]
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
### YamlMime:ModuleUnit
uid: |
learn.a-beginner's-guide-to-prompt-engineering-with-github-copilot.exercise
title: |
exercise
metadata:
title: |
exercise
description: "TODO this field is for search engine optimization and is not user-visible; use 2-3 complete, grammatically correct sentences to describe the unit; include relevant search keywords."
ms.date: 7/11/2023
author: a-a-ron
ms.author: aastewar
ms.topic: interactive-tutorial
###########################################################################
###
### If your content is related to a product or service, apply one value from the either the ms.prod allowlist
### or the ms.service allowlist. You can’t use both ms.prod and ms.service.
###
### If your content isn't about a product or service, you can omit both ms.prod and ms.service.
###
### The list of approved ms.prod values is here: https://review.learn.microsoft.com/help/platform/metadata-taxonomies?branch=main#msprod
### The list of approved ms.service values is here: https://review.learn.microsoft.com/help/platform/metadata-taxonomies?branch=main#msservice
### If you need to request new values, follow the process here: https://review.learn.microsoft.com/en-us/help/platform/metadata-allowlist-requests?branch=main
ms.prod: TODO
ms.service: TODO
durationInMinutes: 1
content: |
[!include[](includes/3-exercise.md)]
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
### YamlMime:ModuleUnit
uid: |
learn.a-beginner's-guide-to-prompt-engineering-with-github-copilot.learning-content
title: |
learning-content
metadata:
title: |
learning-content
description: "TODO this field is for search engine optimization and is not user-visible; use 2-3 complete, grammatically correct sentences to describe the unit; include relevant search keywords."
ms.date: 7/11/2023
author: a-a-ron
ms.author: aastewar
ms.topic: interactive-tutorial
###########################################################################
###
### If your content is related to a product or service, apply one value from the either the ms.prod allowlist
### or the ms.service allowlist. You can’t use both ms.prod and ms.service.
###
### If your content isn't about a product or service, you can omit both ms.prod and ms.service.
###
### The list of approved ms.prod values is here: https://review.learn.microsoft.com/help/platform/metadata-taxonomies?branch=main#msprod
### The list of approved ms.service values is here: https://review.learn.microsoft.com/help/platform/metadata-taxonomies?branch=main#msservice
### If you need to request new values, follow the process here: https://review.learn.microsoft.com/en-us/help/platform/metadata-allowlist-requests?branch=main
ms.prod: TODO
ms.service: TODO
durationInMinutes: 1
content: |
[!include[](includes/4-learning-content.md)]
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
### YamlMime:ModuleUnit
uid: |
learn.a-beginner's-guide-to-prompt-engineering-with-github-copilot.exercise
title: |
exercise
metadata:
title: |
exercise
description: "TODO this field is for search engine optimization and is not user-visible; use 2-3 complete, grammatically correct sentences to describe the unit; include relevant search keywords."
ms.date: 7/11/2023
author: a-a-ron
ms.author: aastewar
ms.topic: interactive-tutorial
###########################################################################
###
### If your content is related to a product or service, apply one value from the either the ms.prod allowlist
### or the ms.service allowlist. You can’t use both ms.prod and ms.service.
###
### If your content isn't about a product or service, you can omit both ms.prod and ms.service.
###
### The list of approved ms.prod values is here: https://review.learn.microsoft.com/help/platform/metadata-taxonomies?branch=main#msprod
### The list of approved ms.service values is here: https://review.learn.microsoft.com/help/platform/metadata-taxonomies?branch=main#msservice
### If you need to request new values, follow the process here: https://review.learn.microsoft.com/en-us/help/platform/metadata-allowlist-requests?branch=main
ms.prod: TODO
ms.service: TODO
durationInMinutes: 1
content: |
[!include[](includes/5-exercise.md)]
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
### YamlMime:ModuleUnit
uid: |
learn.a-beginner's-guide-to-prompt-engineering-with-github-copilot.knowledge-check
title: Knowledge check
metadata:
title: Knowledge check
description: "TODO this field is for search engine optimization and is not user-visible; use 2-3 complete, grammatically correct sentences to describe the unit; include relevant search keywords."
ms.date: 7/11/2023
author: a-a-ron
ms.author: aastewar
ms.topic: interactive-tutorial
###########################################################################
###
### If your content is related to a product or service, apply one value from the either the ms.prod allowlist
### or the ms.service allowlist. You can’t use both ms.prod and ms.service.
###
### If your content isn't about a product or service, you can omit both ms.prod and ms.service.
###
### The list of approved ms.prod values is here: https://review.learn.microsoft.com/help/platform/metadata-taxonomies?branch=main#msprod
### The list of approved ms.service values is here: https://review.learn.microsoft.com/help/platform/metadata-taxonomies?branch=main#msservice
### If you need to request new values, follow the process here: https://review.learn.microsoft.com/en-us/help/platform/metadata-allowlist-requests?branch=main
ms.prod: TODO
ms.service: TODO
durationInMinutes: 1
###########################################################################
###
### General guidance (https://review.docs.microsoft.com/learn-docs/docs/id-guidance-knowledge-check)
###  - Questions are complete sentences ending with a question mark
###  - No true/false questions
###  - 3 answers per question
###  - All answers about the same length
###  - Numeric answers listed in sorted order
###  - No "All of the above" and/or "None of the above" as answer choices
###  - No "Not" or "Except" in questions
###  - No second person ("you") in the questions or answers
###  - Provide a meaningful explanation for both correct and incorrect answers
###
###########################################################################
content: |
quiz:
questions:
- content: ""
choices:
- content: ""
isCorrect: true
explanation: ""
- content: ""
isCorrect: false
explanation: ""
- content: ""
isCorrect: false
explanation: ""
- content: ""
choices:
- content: ""
isCorrect: true
explanation: ""
- content: ""
isCorrect: false
explanation: ""
- content: ""
isCorrect: false
explanation: ""
- content: ""
choices:
- content: ""
isCorrect: true
explanation: ""
- content: ""
isCorrect: false
explanation: ""
- content: ""
isCorrect: false
explanation: ""
- content: ""
choices:
- content: ""
isCorrect: true
explanation: ""
- content: ""
isCorrect: false
explanation: ""
- content: ""
isCorrect: false
explanation: ""
- content: ""
choices:
- content: ""
isCorrect: true
explanation: ""
- content: ""
isCorrect: false
explanation: ""
- content: ""
isCorrect: false
explanation: ""
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
### YamlMime:ModuleUnit
uid: |
learn.a-beginner's-guide-to-prompt-engineering-with-github-copilot.summary
title: |
summary
metadata:
title: |
summary
description: "TODO this field is for search engine optimization and is not user-visible; use 2-3 complete, grammatically correct sentences to describe the unit; include relevant search keywords."
ms.date: 7/11/2023
author: a-a-ron
ms.author: aastewar
ms.topic: interactive-tutorial
###########################################################################
###
### If your content is related to a product or service, apply one value from the either the ms.prod allowlist
### or the ms.service allowlist. You can’t use both ms.prod and ms.service.
###
### If your content isn't about a product or service, you can omit both ms.prod and ms.service.
###
### The list of approved ms.prod values is here: https://review.learn.microsoft.com/help/platform/metadata-taxonomies?branch=main#msprod
### The list of approved ms.service values is here: https://review.learn.microsoft.com/help/platform/metadata-taxonomies?branch=main#msservice
### If you need to request new values, follow the process here: https://review.learn.microsoft.com/en-us/help/platform/metadata-allowlist-requests?branch=main
ms.prod: TODO
ms.service: TODO
durationInMinutes: 1
content: |
[!include[](includes/7-summary.md)]
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
<!-- 1. Topic sentence(s) --------------------------------------------------------------------------------

Goal: orient the learner to the area covered in this module

Heading: none

Example: "Azure Logic Apps let you automate your business processes and run them in the cloud."

Recommended: visual like an image, table, list, etc. that supports the topic sentence(s)

[Introduction unit guidance](https://review.docs.microsoft.com/learn-docs/docs/id-guidance-introductions?branch=main#rule-use-the-standard-module-introduction-format)
-->
TODO: add your topic sentences(s)
TODO: add a visual element

<!-- 2. Scenario -----------------------------------------------------------------------------------------

Goal: describe the real-world scenario this module will use to illustrate the concepts

Heading: "## Example scenario"

Example: "Suppose you work at an athletic shoe company on the marketing team. You're launching a new basketball shoe created by a celebrity athlete. Previous launches resulted in a social media frenzy as people shared stories and photos of themselves wearing their new shoes. The marketing team wants to monitor hundreds of social media sites, blogs, and websites to determine consumer reaction. There will be more data than you can process manually. You would like a cloud-hosted system that automates monitoring, text analytics, database storage, and email notifications."

Recommended: an image that visualizes the scenario, use the image markdown extension (https://review.docs.microsoft.com/help/contribute/markdown-reference?branch=main#images)

Optional: a "scenario video" that visualizes the scenario

[Scenario guidance](https://review.docs.microsoft.com/learn-docs/docs/id-guidance-scenarios)
[Scenario video guidance](TBD)
-->
## Example scenario
TODO: add your scenario
TODO: add a visual element

<!-- 3. Prose table-of-contents --------------------------------------------------------------------------

Goal: List the activities the learner will do in this content. This differs from the title and the learning objectives. The title and the learning objectives are "outcome focused"; that is, they describe the skills the learner will acquire as a result of consuming this content. By contrast, here you should be specific about what the learning will **do** in order to acquire those skills. The format can be either prose or bulleted-list; however, a list will yield better results when transformed into other output types such as PowerPoint.

Heading: "## What will we be doing?"

Example: "Here, you'll create a business workflow using Azure Logic Apps to automate the processing of tweets:
* **Launch**: when a new tweet is available
* **Process**: determine if the sentiment of the tweet is positive or negative
* **Route**: branch based on the sentiment score"

-->
## What will we be doing?
TODO: add your activities

<!-- 4. Terminal learning objective ----------------------------------------------------------------------

Goal: This is a restatement of the module title into a complete sentence. You have more room here to convey the main goal than in a space-limited title. Make it outcome-focused so it describes the main skill the learner will acquire as a result of this training. In other words, it should answer the question: "what is the key thing the learner will be able to do as a result of consuming this training?"

Heading: "## What is the main goal?"

Example: "By the end of this session, you'll be able to create workflows which route and process data using Azure Logic Apps and its built-in connectors."

-->
## What is the main goal?
By the end of this session, you'll be able to (TODO)

<!-- Do **not** include any other content like learning objectives, prerequisites, unit summary, "next unit" lead-in, or references. -->
Loading