diff --git a/.github/aw/agentic-chat.md b/.github/aw/agentic-chat.md index 420b48ccd30..276d11ab744 100644 --- a/.github/aw/agentic-chat.md +++ b/.github/aw/agentic-chat.md @@ -15,7 +15,7 @@ Before assisting users, load and understand these instruction files from the gh- https://raw.githubusercontent.com/github/gh-aw/main/.github/aw/github-agentic-workflows.md 2. **Dictation Instructions**: - https://raw.githubusercontent.com/github/gh-aw/main/skills/dictation/SKILL.md + https://raw.githubusercontent.com/github/gh-aw/main/DICTATION.md ## Core Principles diff --git a/.github/workflows/dictation-prompt.md b/.github/workflows/dictation-prompt.md index c73fac7d65c..d659c7c5e60 100644 --- a/.github/workflows/dictation-prompt.md +++ b/.github/workflows/dictation-prompt.md @@ -46,7 +46,7 @@ Extract technical vocabulary from documentation files and create a concise dicta ## Your Mission -Create a concise dictation instruction file at `skills/dictation/SKILL.md` that: +Create a concise dictation instruction file at `DICTATION.md` that: 1. Contains a glossary of exactly 256 project-specific terms extracted from documentation 2. Provides instructions for fixing speech-to-text errors (ambiguous terms, spacing, hyphenation) 3. Provides instructions for "agentifying" text: removing filler words (humm, you know, um, uh, like, etc.), improving clarity, and making text more professional @@ -108,7 +108,7 @@ Read each returned file path for its content, then also scan any remaining docum ### 3. Create the Dictation Instructions File -Create `skills/dictation/SKILL.md` with: +Create `DICTATION.md` with: - Frontmatter with name and description fields - Title: Dictation Instructions - Technical Context: Brief description of gh-aw @@ -131,7 +131,7 @@ You do not have enough background information to plan or provide code examples. Use the create-pull-request tool to submit your changes with: - Title: "[docs] Update dictation skill instructions" -- Description explaining the changes made to skills/dictation/SKILL.md +- Description explaining the changes made to DICTATION.md ## Guidelines @@ -145,8 +145,8 @@ Use the create-pull-request tool to submit your changes with: ## Success Criteria -- ✅ File `skills/dictation/SKILL.md` exists -- ✅ Contains proper SKILL.md frontmatter (name, description) +- ✅ File `DICTATION.md` exists +- ✅ Contains proper frontmatter (name, description) - ✅ Contains 256 project-specific terms (240-270 acceptable) - ✅ Terms extracted from documentation only - ✅ Focuses on fixing speech-to-text errors diff --git a/AGENTS.md b/AGENTS.md index 29c1b16797f..593c824fdb7 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1294,7 +1294,7 @@ Skills provide specialized, detailed knowledge on specific topics. **Use them on ### Documentation & Communication - **[documentation](skills/documentation/SKILL.md)** - Documentation guidelines using Diátaxis framework and GitHub-flavored markdown - **[reporting](skills/reporting/SKILL.md)** - Report format guidelines using HTML details/summary tags -- **[dictation](skills/dictation/SKILL.md)** - Fixing text-to-speech errors in dictated text +- **[dictation](DICTATION.md)** - Fixing text-to-speech errors in dictated text - **[agentic-chat](.github/aw/agentic-chat.md)** - AI assistant for creating task descriptions ### MCP & Tools diff --git a/skills/dictation/SKILL.md b/DICTATION.md similarity index 100% rename from skills/dictation/SKILL.md rename to DICTATION.md diff --git a/docs/src/content/docs/guides/agentic-authoring.mdx b/docs/src/content/docs/guides/agentic-authoring.mdx index 7e9fcea9753..137df07fb33 100644 --- a/docs/src/content/docs/guides/agentic-authoring.mdx +++ b/docs/src/content/docs/guides/agentic-authoring.mdx @@ -90,6 +90,6 @@ Copy the instructions, paste into your AI chat, then describe your workflow goal ### Dictation -When creating agentic workflows using speech-to-text, use the [dictation instructions prompt](https://raw.githubusercontent.com/github/gh-aw/main/skills/dictation/SKILL.md) to correct terminology mismatches and formatting issues. +When creating agentic workflows using speech-to-text, use the [dictation instructions prompt](https://raw.githubusercontent.com/github/gh-aw/main/DICTATION.md) to correct terminology mismatches and formatting issues. This prompt corrects terminology (e.g., "ghaw" → "gh-aw", "work flow" → "workflow"), transforms casual speech into imperative task descriptions, removes filler words, and adds implicit context. Load it into your AI assistant before or after dictating. diff --git a/docs/src/content/docs/reference/custom-agent-for-aw.mdx b/docs/src/content/docs/reference/custom-agent-for-aw.mdx index ce83bf53d85..1134d8f9d7e 100644 --- a/docs/src/content/docs/reference/custom-agent-for-aw.mdx +++ b/docs/src/content/docs/reference/custom-agent-for-aw.mdx @@ -119,7 +119,7 @@ Copy the instructions into your AI chat interface, describe your workflow goal, ## Dictating Agentic Workflows -When creating agentic workflows using speech-to-text (dictation), you may encounter terminology mismatches and formatting issues common to voice recognition systems. To help correct these issues, use the [dictation instructions prompt](https://raw.githubusercontent.com/github/gh-aw/main/skills/dictation/SKILL.md) or . +When creating agentic workflows using speech-to-text (dictation), you may encounter terminology mismatches and formatting issues common to voice recognition systems. To help correct these issues, use the [dictation instructions prompt](https://raw.githubusercontent.com/github/gh-aw/main/DICTATION.md) or . This prompt corrects terminology (e.g., "ghaw" → "gh-aw"), removes filler words, and transforms dictated sentences into clear, imperative task descriptions. Load it into your AI assistant before or after dictating to improve accuracy.