Merge branch 'ServiceNowDevProgram:main' into main

sravankadudhuri · web-flow · commit 89302f92f85d · 2024-10-01T14:57:01.000+05:30
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,20 +1,50 @@
-# Contributing
+![promptlibrary Banner](https://github.com/user-attachments/assets/247f5479-90ce-4928-a15d-dabeab7797d8)
 
-## General requirements
+# Contributing to the ServiceNow's GenAI Prompt Library 🎉
 
-- Pull requests should be **only** to add or modify files inside the `Prompts` folder.
-- The filename **must** be a description of what the prompt does.
-- Filenames should not have special characters that are not allowed on normal file systems (eg. do not put ! in the file name).
-- No low-effort submissions.
-  - example of low-effort: "Generate discussion topics about ServiceNow"
-  - example of good-effort: including an example of what you are looking for, giving context of what this will be used for, giving a goal with the prompt, adding what kind of audience would be benefitting from this, etc.
+Thank you for your interest in contributing to the Prompt Library! We appreciate your help in making this resource better for everyone. 🙌
 
-## Recommendations
+## How to Contribute
 
-Need some guidance? The RISEN framework helps structure tasks for generative AI into actionable steps:
+### 1. Think of a Prompt 💭
 
-- **R** — Role: Define the AI's role. (e.g., "Act as an agile coach.")
-- **I** — Instructions: Provide clear instructions. (e.g., "Write a guide on crafting a good agile development story.")
-- **S** — Steps: Outline specific steps. (e.g., "Start with a user persona, describe the user's goal, list the tasks to achieve the goal, and define the acceptance criteria.")
-- **E** — End goal: State the goal and audience. (e.g., "Help team members understand how to write clear and effective agile stories.")
-- **N** — Narrowing: Add constraints. (e.g., "Max 800 words, avoid technical jargon, use practical examples.")
+Consider a prompt you frequently use in your day-to-day work as a ServiceNow professional. This could include:
+
+- Prompts that help write emails ✉️.
+- Prompts for generating specific code snippets 💻.
+- Prompts that assist in creating documentation 📚.
+- Prompts tailored for using providers like ChatGPT with your ServiceNow experience.
+
+For inspiration, you can view the top-voted prompts in the library [here](https://communityresources.service-now.com/ai?id=library&display=10&sort=true). 
+
+### 2. Submit a Prompt 📥
+
+To submit your prompt, follow these steps:
+
+#### Creating a New File
+
+1. **Fork the Repository:** Click the "Fork" button at the top right of this page to create your own copy of the repository.
+2. **Create a New Branch:** In your forked repository, create a new branch for your prompt submission.
+3. **Add a New File:** Navigate to the `Prompts` folder in your branch and create a new file. Make sure to follow the guidelines outlined below to ensure your submission is acceptable.  
+   ![Creating a file](https://github.com/user-attachments/assets/64a259da-7ff8-491c-91ba-eddf1414219e)
+4. **Submit a Pull Request:** Once your prompt is ready, submit a pull request to the main repository. One of our moderators will review your submission.
+
+<br />
+
+## Guidelines for Submission 📝
+
+- Ensure that your prompt is clear and concise.
+- Include any necessary context or examples to help others understand its use.
+- Follow the naming conventions and formatting as specified in the repository.
+
+<hr />
+
+### See Your Prompt Live 🌟
+
+Once your submission is accepted, it will immediately appear in the Prompt Library, which can be viewed at [Prompt Library](https://devlink.sn/PromptLibrary).
+
+![Result in Prompt Library](https://github.com/user-attachments/assets/d9606aec-da1c-400c-9ba8-273c663e9807)
+
+Any logged-in user will be able to comment on and vote for your submission, helping to highlight valuable prompts. 👍
+
+### Thank you for contributing to the Prompt Library! We look forward to seeing your creative prompts. 🚀
diff --git a/Prompts/Create a Security Incident Playbook b/Prompts/Create a Security Incident Playbook
@@ -0,0 +1,15 @@
+Assume the role of a cybersecurity analyst tasked with creating a playbook for managing security incidents in ServiceNow. 
+The playbook should provide a structured, repeatable process for addressing any type of security incident. 
+
+Follow these steps:
+
+1. Detection: Define how to identify and validate a wide range of security incidents, including proper documentation.
+2. Analysis: Guide the team through assessing scope, impact, and root cause, using logs and relevant tools.
+3. Containment: Outline short-term and long-term strategies to prevent the threat from spreading.
+4. Eradication: Provide steps for removing the root cause, such as eliminating malware or securing compromised accounts.
+5. Recovery: Describe how to restore affected systems and validate that the environment is secure and operational.
+6. Post-Incident Review: Include a process for conducting a review, capturing lessons learned, and identifying improvements for future incidents.
+
+The playbook should provide IT teams with a clear, repeatable process for addressing security incidents in ServiceNow, ensuring minimal downtime and data loss.
+The template should be concise, limited to 600 words, clear, and easy to follow for both technical and non-technical users.
+It should provide practical examples without delving too deep into technical jargon. 
diff --git a/Prompts/Prompt for removing all logging statements from a script b/Prompts/Prompt for removing all logging statements from a script
@@ -0,0 +1,8 @@
+Prompt for removing all logging statements from a script.
+
+PURPOSE
+This prompt would assist developers who use logging statements to troubleshoot issues but forget to remove them from scripts before moving to production.
+
+PROMPT
+Review the JavaScript code in <INSERT RECORD HERE> and remove all logging statements that use the gs.log, gs.info, gs.debug, gs.logError and gs.logWarning functions.
+Provide the updated script back to me, identifying where logging statements have been removed.
diff --git a/Prompts/Prompt for summarising my assigned stories for a stand-up meeting b/Prompts/Prompt for summarising my assigned stories for a stand-up meeting
@@ -0,0 +1,9 @@
+Prompt for summarising my assigned stories for a stand-up meeting.
+
+PURPOSE
+As a developer, I have already added all the necessary comments to my stories. This prompt should summarise the current status of my assigned stories using the state and notes fields on the records in order to 
+provide a summary that would be suitable to present in a stand-up.
+
+PROMPT
+You will be presenting a summary of agile stories during a stand-up meeting with the team. Please summarise all of my assigned stories, utilising fields such as state, work notes and comments, focussing on anything 
+that might be considered a blocker. Keep the response to something that can be presented in 2 to 3 minutes.
diff --git a/Prompts/Prompt to create a description for a catalog item b/Prompts/Prompt to create a description for a catalog item
@@ -0,0 +1,9 @@
+Prompt to create a description for a catalog item.
+
+PURPOSE
+As a developer, lanugage is not always our strongest skill. Often customers are also very vague when it comes to what they want in a description field for a catalog item. Using AI, generate a suitable description
+for a catalog item.
+
+PROMPT
+You are creating a new catalog item/form with the main audience being non-technical end users. Please provide a customer centric, non-technical description for the catalog item/form whos purpose is the following:
+<INSERT DETAILED DESCRIPTION OF CATALOG ITEM/FORM HERE>
diff --git a/Prompts/Prompt to generate ServiceNow Virtual Agent Topic b/Prompts/Prompt to generate ServiceNow Virtual Agent Topic
@@ -0,0 +1,17 @@
+You’re a ServiceNow Virtual Agent developer with extensive experience in creating interactive and user-friendly topics. You have a knack for engaging users while efficiently guiding them through processes based on their needs and preferences. Your goal is to design a ServiceNow Virtual Agent topic that facilitates user interactions regarding requests and incidents seamlessly.
+
+Your task is to create a ServiceNow Virtual Agent topic that begins by greeting the user and then offers them a choice between creating a Request or creating an Incident. If the user chooses to create an Incident, the topic should redirect the user to the Create Incident Record Producer on the Service Portal. Conversely, if the user opts to create a Request, it should prompt the user for a description of the request, recommend relevant catalog items based on the description, and subsequently ask the user to select the required catalog item before redirecting them to the Service Portal page for fulfillment.
+
+Please keep in mind the following details while creating the topic flow:
+- The initial greeting should be friendly and welcoming.
+- Ensure that the options are clear and concise for easy user selection.
+- When collecting the request description, encourage the user to provide as much detail as possible for accurate recommendations.
+- Use appropriate ServiceNow terminology to maintain professionalism.
+- The flow should be straightforward and guide the user without overwhelming them.
+
+Here’s a structured flow for the ServiceNow Virtual Agent topic: 
+- Greeting: “Hello! How can I assist you today?”
+- Ask for the user’s choice: “Would you like to create a Request or an Incident?” 
+- Based on the user’s selection, provide the appropriate redirect or prompt:
+  - If Incident is chosen: “You’ve chosen to create an Incident. Redirecting you to the Create Incident Record Producer on the Service Portal…”
+  - If Request is chosen: “Please provide a description of the request you would like to create: .” Based on the description, recommend catalog items like: “Based on your description, here are some relevant catalog items: . Please select the required catalog item:  and I will redirect you to the Service Portal page for fulfillment.”
diff --git a/README.md b/README.md
@@ -10,41 +10,3 @@ The Prompt Library itself, is a community-driven hub for ServiceNow professional
 
 Note, this repository _can_ be installed on your ServiceNow instance but contributions to this repository are for **Prompt Submission only**. See [CONTRIBUTING.md](CONTRIBUTING.md) for full details.
 
-## Contributing process
-
-### Think of a prompt
-
-Have a prompt you use often in your day-to-day work as a ServiceNow professional?
-
-Examples:
-- Prompts that write emails for you
-- Prompts that generate very specific code snippets
-- Prompts that help you create documentation
-- Prompts that help you tailor providers like ChatGPT to your ServiceNow experience specifically
-- Etc.
-
-That's what we're looking for! If you want examples, you can see the top-voted ones at the library at this link: https://communityresources.service-now.com/ai?id=library&display=10&sort=true
-
-### Submit a prompt
-
-In this repository, create a new file in the `Prompts` folder and submit it.
-
-![Creating a file](https://github.com/user-attachments/assets/64a259da-7ff8-491c-91ba-eddf1414219e)
-
-
-#### How to submit (walkthrough)
-
-1. Fork this repo
-2. Create a new branch on your forked repo
-3. Add a new file to your `Prompts` folder. Make sure to follow all the instructions on [CONTRIBUTING.md](CONTRIBUTING.md) to ensure your submission is acceptable.
-4. Submit a pull request!
-
-One of our moderators will then review your pull request.
-
-### See it live in the Prompt Library
-
-Accepted submissions/pull requests will immediately be visible at the Prompt Library at https://devlink.sn/PromptLibrary
-
-![Result in Prompt Library](https://github.com/user-attachments/assets/d9606aec-da1c-400c-9ba8-273c663e9807)
-
-Any logged in user will be able to comment and vote on your submission!
