centersl/docker-docs
1
0
Fork 0
mirror of https://github.com/docker/docs.git synced 2026-03-27 06:18:55 +07:00
Code Issues Packages Projects Releases Wiki Activity

tooling: add prompts to vscode (#23030)

Browse Source
This commit is contained in:
Arthur
2025-07-08 17:27:47 +02:00
committed by GitHub
parent b8553216d3
commit b836d25e79
4 changed files with 156 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
.github/prompts/freshness-tier1.prompt.md vendored Normal file
View File

@@ -0,0 +1,16 @@
---
mode: 'edit'
---
Imagine you're an experienced technical writer. You need to review content for
how fresh and up to date it is. Apply the following:
1. Fix spelling errors and typos
2. Verify whether the markdown structure conforms to common markdown standards
3. Ensure the content follows our [style guide file](../instructions/styleguide-instructions.md) as a guide.
4. Make sure the titles on the page provide better context about the content (for an improved search experience).
5. Ensure all the components formatted correctly.
6. Improve the SEO keywords.
7. If you find numbered lists, make sure their numbering only uses 1's.
Do your best and don't be lazy.

22
.github/prompts/freshness-tier2.prompt.md vendored Normal file
View File

@@ -0,0 +1,22 @@
---
mode: 'edit'
---
Imagine you're an experienced technical writer. You need to review content for
how fresh and up to date it is. Apply the following:
1. Improve the presentational layer - components, splitting up the page into smaller pages
Consider the following:
1. Can you use tabs to display multiple variants of the same steps?
2. Can you make a key item of information stand out with a call-out?
3. Can you reduce a large amount of text to a series of bullet points?
4. Are there other code components you could use?
2. Check if any operating systems or package versions mentioned are still current and supported
3. Check the accuracy of the content
4. If appropriate, follow the document from start to finish to see if steps make sense in sequence
5. Try to add some helpful next steps to the end of the document, but only if there are no *Next steps* or *Related pages* section, already.
6. Try to clarify, shorten or improve the efficiency of some sentences.
7. Check for LLM readibility.
Do your best and don't be lazy.

7
.github/prompts/review.prompt.md vendored Normal file
View File

@@ -0,0 +1,7 @@
---
mode: edit
description: You are a technical writer reviewing an article for clarity, conciseness, and adherence to the documentation writing style guidelines.
---
Review the article for clarity, conciseness, and adherence to our documentation [style guidelines](../instructions/styleguide-instructions.md).
Provide concrete and practical suggestions for improvement.