Skip to main content

Prompt Templates

Add assorted AI prompts in this file to expedite glossary workflows.

Annotated Screenshots​

  1. Attach published annotated screenshot examples
  2. Attach current glossary term entry for context
  3. Edit and execute the following:
I'm working on the API Docs Glossary. Here are links to the GitHub
repository project and its rendered docs:

https://github.com/rhyannonjoy/api-docs-glossary
https://rhyannonjoy.github.io/api-docs-glossary/

I'd like to create an annotated screenshot for the `[glossary term]`
entry. What do you think should be annotated in this new screenshot?
Please create a Markdown table legend of components that you think
should be annotated in the screenshot. I've added an example annotated
screenshot for a published glossary term entry.

Mermaid Diagrams​

  1. Attach current glossary term for context
  2. Edit and execute the following:
Please help me decide what will be the most impactful Mermaid diagram for
this glossary **Example** field scenario. I'm thinking a `[diagram type]`
diagram. Ensure that your output is in Markdown and Mermaid format, so that
I can copy and paste it easily.

Note: flowcharts TD tend to take up too much site real estate and flowcharts RL tend to not be readable without wrapping it in a zoom component

New Glossary Term Entries​

  1. Attach Style Guide
  2. Attach preferred sources
  3. Edit and execute the following:
I’d like to add a glossary term entry to my API Docs Glossary:

https://github.com/rhyannonjoy/api-docs-glossary

Terms to add:
* [Term 1]
* [Term 2]
* [Term 3]

I think these terms should go in [FILENAME], in the [SECTION NAME] section,
do you agree?

Please follow the Style Guide recommendations
[paste or link to [Style Guide](style-guide.mdx)] - write in active voice and
generate output in Markdown so that I can copy and paste it easily. Use the
following sources: 

* [Source URL 1]
* [Source URL 2]
* [Source URL 3]

Ensure that the **Example** scenario is realistic and practical.

Note: Be as specific as possible. If you have questions, communicate them with reasoning, "I'm thinking of filing the term into [category and/or subcategory], because it fundamentally describes [reason] - do you agree?" This may lead to expanding the entry to include placement reasoning or visual components to accurately represent the term.

Standardizing Existing Entries​

Please review these glossary entries against Style Guide recommendations
[paste or link to [Style Guide](style-guide.mdx)] and suggest improvements:

Term entries to review:
* [Term Entry 1]
* [Term Entry 2]
* [Term Entry 3]

Focus on capitalization rules, definition clarity, formatting consistency,
and **Related Terms** anchor linking