--- name: Dictation Instructions description: Instructions for fixing speech-to-text errors and improving text quality in gh-aw documentation and workflows --- # Dictation Instructions ## Technical Context GitHub Agentic Workflows (gh-aw) is a Go-based GitHub CLI extension for writing AI-powered workflows in natural language using markdown files that compile to GitHub Actions YAML. ## Project Glossary The following project-specific technical terms should be corrected when encountered in speech-to-text input: .github .github/aw .github/workflows .lock.yml .md @copilot ACTIONS_STEP_DEBUG ANTHROPIC_API_KEY ANTHROPIC_BASE_URL CLAUDE_CODE_OAUTH_TOKEN CODEX_API_KEY COPILOT_GITHUB_TOKEN DEBUG FUZZY:BI-WEEKLY FUZZY:DAILY FUZZY:HOURLY FUZZY:TRI-WEEKLY FUZZY:WEEKLY GEMINI_API_KEY GH_AW_ACTION_MODE GH_AW_AGENT_TOKEN GH_AW_ALLOWED_DOMAINS GH_AW_CI_TRIGGER_TOKEN GH_AW_GITHUB_MCP_SERVER_TOKEN GH_AW_GITHUB_TOKEN GH_AW_PHASE GH_AW_PROJECT_GITHUB_TOKEN GH_AW_PROMPT GH_AW_READ_PROJECT_TOKEN GH_AW_SAFE_OUTPUTS GH_AW_SAFE_OUTPUTS_PORT GH_AW_SAFE_OUTPUTS_STAGED GH_AW_VERSION GH_AW_WORKFLOW_ID GH_AW_WRITE_PROJECT_TOKEN GH_TOKEN GITHUB_ACTIONS GITHUB_ACTOR GITHUB_COPILOT_BASE_URL GITHUB_PERSONAL_ACCESS_TOKEN GITHUB_REF GITHUB_REPOSITORY GITHUB_SERVER_URL GITHUB_STEP_SUMMARY GITHUB_TOKEN GITHUB_WORKFLOW GITHUB_WORKSPACE ITERATION MEMBER NDJSON NONE OPENAI_API_KEY OPENAI_BASE_URL OWNER RUNNER_TEMP SARIF SLACK_WEBHOOK access accessible action action-mode action-pins.json action-repo action-version action.yml action_pins.json actionlint actions actions-lock.json actions-read actions/cache actions/checkout actions/github-script actions/setup-dotnet actions/setup-go actions/setup-java actions/setup-node actions/setup-python activation activation-app-token activation-job active actor actual add-comment add-comment.discussions add-labels add-labels.allowed add-reviewer additional after_run_id agent-job agent_output.json agentic agentic-workflows agentics-maintenance.yml agents ai-generated ai-moderator allow allow-workflows allowed allowed-domains allowed-events allowed-extensions allowed-files allowed-github-references allowed-labels allowed-pull-request-repos allowed-reasons allowed-repos allowed_repositories allowlist analysis analyze_imports api-key api-target api.github.com apiKey app-id append append-only-comments apply approval approval-labels approved architecture args artifact artifacts assign assign-milestone assign-to-agent assign-to-bot assign-to-copilot assign-to-user assignee assignees assignment audit audit-finding audit-workflows audits auto-close auto-merge auto-triage-issues autofix-code-scanning-alert automation automation-enabled availability aw-patch aw.patch aw_info.json awf-diagnostic-logs background banner base-branch bash before_run_id bi-weekly blob blocked blocked-users board boards body boolean boolean-field branch branch-name branch-prefix branch_name branches branches-ignore breaking breaking-change bug build builds bun cache cache-key cache-memory cached caches call-workflow capabilities capture category category-filter changes characters chart charts charts-with-trending chat-ops chatops checkout checkouts checks choice claude claude-haiku-4-5 claude-sonnet-4.5 cleanup close-discussion close-issue close-older-discussions close-older-issues close-pull-request close_older closed cluster code-scanning codespaces codex coding coding-agent collaboration collection command commands comment comment-body comment-thread comment_id comment_repo commit commit-changes commits compile compile-stable compile-time compile-workflow compileWorkflow compiled compiled_file compiler completion compliance component component-spec components conclusion conclusion-check concurrency concurrency-group concurrency.job-discriminator config configuration-file configurations configure configured conflicts connection console constraints container container.env containerized containers content content-security content.message content.path content.size content.type contents context context-variable contributors control copilot copy-from core count-limit coverage create-agent-session create-code-scanning-alert create-discussion create-discussion.labels create-issue create-issue.labels create-project create-project-status-update create-pull-request create-pull-request-review-comment create-pull-request.fallback-as-issue create-pull-request.labels create_discussion create_fields create_issue create_labels create_project create_pull_request create_pull_request_review_comment create_views created_issue_number created_issue_url created_pr_number created_pr_url creation credentials criteria cron cross-repo cross-repository custom custom-agent customSchemas customServerConfig daily daily-ops data-analysis data-ops data-server database date day-of-week days debug debug-logging deep deepwiki default default-branch defaults definition definitions delete_symbol demand deno dependabot dependencies deploy deploy-app deploy-preview deployment deployment-check deployments description description-field destination details detection devcontainer.json development directory disable disabled discussion discussion_comment discussion_number discussions dispatch dispatch-ops dispatch-workflow dispatch_repository dispatched dispatching docker documentation domains dotnet download downloaded_files downstream draft duplicate echo-command ecosystem edit effective-tokens empty enabled encoding/json end_date endpoints enforce enforcement engine engine-config engine.concurrency engine.env engines entity entrypoint entrypointArgs environment environment-variables ephemerals error errors event-filter event-trigger events exec execute execution execution-context executor experiments expiration-date expire expires explicit explore expressions extension extraction fail-fast failures fallback fallback-as-issue fallback-to-issue false faster feature feature-flag features feedback fetch file-glob file-path filesystem filter find_anomalies find_files find_referencing_symbols find_symbol firewall firewall-audit-logs flag flags fmt footer footer-install footer-text force-push force-update forks formatted frontmatter frontmatter-field function functionality functions fuzzy fuzzy-schedule gateway gateway.apiKey gateway.jsonl gateway.trustedBots gatewayConfig gatewayVersion gemini generate generate-report generated generation get_file_contents get_me get_project_structure get_pull_request get_repository get_symbol_definition get_symbols_overview get_team_members get_teams get_user gh-aw gh-aw-as-mcp-server git-branch git-commit git-diff git-status github github-actions github-app github-app-token github-context github-graphql github-script github-token github.actor github.base_ref github.event.issue.number github.event.pull_request.number github.job github.owner github.ref_name github.repository github.run_id github.run_number github.server_url github.workflow github.workspace github/gh-aw global glossary go-mod-file guard-policy guidance guides handlers hash-check headers health health-check hide-comment high-priority host host-network hour hourly hourly-schedule hours http http-request https id-token identifier identifiers if-condition implement implementation implements import-path import-schema importResolver imported imports incremental injection-protection input input-field input-validation inputs insert_after_symbol insert_before_symbol inspect install install-gh installation instructions integration integrity-proxy integrity-reactions interactive-mode interface isolation issue issue-ops issue-triage issue_comment issue_number issueops issues iterations java javascript job-discriminator job-output jobs jq json json-schema keys keyword keyword-search knowledge label label-filter label-ops label_command labeled labeling labelops labels language language-detection latest layer libraries limit limit-per-run limits line lines link-sub-issue linking list_code_scanning_alerts list_codemods list_commits list_discussions list_issues list_pull_requests list_symbols_in_file list_users list_workflow_runs list_workflows load local lock lock-file lockdown lockdown-mode lockfile logic logs loops machine main maintainer management managing manual manual-approval manually markdown match matching max-continuations max-file-count max-file-size max-patch-size max-turns max_tokens maximize mcp mcp-gateway mcp-inspect mcp-list mcp-registry mcp-scripts mcp-scripts-mode-removal mcp-scripts.mode mcp-server mcp-servers mcp.port mcp_failures mechanism mechanisms member memory mention merge merged messages metadata metadata-read migrate milestone min-integrity minimal mode model module modules monitoring monthly-report multi-repo multirepo multirepoops needs.activation network network-firewall-migration network.allowed network.firewall nightly-run node none noop null observability.otlp on-demand operations operations-log operator optional orchestration orchestrator org organization organization-projects organizations organize outdated output-field output-variable outputs override overrides owner owner-name package package.json parallel parameters parent parent_issue_number parsing patch patch-update path paths patterns payloadDir payloadPath payloadPathPrefix payloadSizeThreshold permissions phase phases php pin-versions pinned pinning pip pipeline playwright plugins plugins.github-token post-steps poutine powershell pr-comment pr-event pr-fix pr-label pr-merge pr-review pr-title pre-activation pre-check pre_activation prepend preview.first_item preview.item_count preview.schema priority private private-key privilege problem process processes project project-board project-column project-field project-id project-item project-number project-status project-title project-url project-view projectops projects prompt prompt-injection protected-files protection protocol provider public public_repo pull-request-repo pull-requests pull_number pull_request pull_request_comment pull_request_number pull_request_review_comment pull_request_target pull_requests purpose push-ref push-to-branch push-to-pull-request-branch py python python3 qmd quality quality-gate query quick-start ranges rate rate-limit rate-limiting reactions read read-all read-only read-permission ready-for-review recommendations recompile reference references regenerate registry related relationships release remote remote-server remove-labels replace replace-island replace_symbol_body reply-to-pull-request-review-comment reply_to_pull_request_review_comment repo repo-memory repo-ops repomix report-as-issue report-summary report_diagnostics_to_pull_request reporting repos repository repository_dispatch repository_features_validation repository_slug requirements.txt research resolution resolve-pull-request-review-thread resolveReviewThread respond response retention-days retrieve reusable reuse review reviewer reviewers reviews roles ruby run-context run-failure run-id run-name run-started run-success run_id_or_url runner running runs runs-on runs-on-slim runtime runtime-env runtimes rust safe safe-inputs safe-inputs-mode-removal safe-inputs.mode safe-mode safe-output-app safe-outputs safe-outputs.app safe-outputs.concurrency-group safe-outputs.env safe-outputs.footer safe-outputs.jobs safe-outputs.messages safe-outputs.runs-on safe-outputs.staged safe-outputs.threat-detection safe_outputs sandbox sandbox-agent-false-removal sandbox.agent.env sandbox.agent.mounts sandbox.mcp.env sandbox.mcp.trusted-bots sanitized scale scenarios schedule schedule-cron scheduled schedules schema schemas scope script script-step scripts search secret-key secret-masking secrets security security-events semantic sensitive separate serena services session session-analysis session-insights setup severity share shared shared-workflow shared/common-tools shared/file shared/gh shared/mcp sharing shell shows sidebar similar size skillz skip skip-bots skip-if-match skip-if-no-match skip-roles slack slash slash_command small software source source-destination spec-ops specVersion specfile specifications specified specifies specify staged staged-description staged-mode staged-title staging stale standard start_date startupTimeout state states static status-update-id stdio steps.sanitized.outputs.body steps.sanitized.outputs.text steps.sanitized.outputs.title stop-after strict string structured sub-issues sub_issue_number submit-pull-request-review submit_pull_request_review summary system target-repo task-ops tavily tavily-search template template-file temporary-id temporary_id testing threat-detection time_remaining timeout timeout-minutes timeout-minutes-migration timeout_minutes timestamp timezone timezone-offset title-prefix todo token-weights tokens toolTimeout tool_usage toolsets traceparent tracker-id tracking tracking-issue transform translation trial trial-ops trials trigger trigger-event triggers trusted trusted-domain trusted-users trustedBots ubuntu ubuntu-22.04 ubuntu-24.04 ubuntu-latest ubuntu-slim unassign-first unassign-from-user unique unstructured update-discussion update-issue update-project update-pull-request update-release upgrade upload-asset users utc-N valid validate validated validation values variables variations vars verbose verbose-mode version version-bump version-check views visibility visible-fields volume vulnerability-scan wasm wasm-compilation watch web-fetch web-search webhook webhook-notify webhook_notify weekly weekly-ops weekly-research weekly-summary worker workflow workflow-compile workflow-compiler workflow-dispatch workflow-generator workflow-health-manager workflow-run workflow-status workflow-trigger workflow_call workflow_dispatch workflow_file workflow_file_path workflow_name workflow_run workflows workflows/ workspace write-all write-permission yaml zizmor zsh ## Fix Speech-to-Text Errors When fixing dictated text, correct these common misrecognitions: ### GitHub and Git Terms - "get hub" → github - "git lab" → gitlab - "get actions" → github-actions - "pull request" → pull-request (when used as compound modifier) - "issue ops" → issueops - "label ops" → labelops - "chat ops" → chatops - "multi repo ops" → multirepoops - "project ops" → projectops - "data ops" → data-ops - "dispatch ops" → dispatch-ops - "daily ops" → daily-ops ### Workflow Configuration - "front matter" → frontmatter - "safe outputs" → safe-outputs (in configuration context) - "safe inputs" → safe-inputs (in configuration context) - "lock file" → .lock.yml or lockfile (depending on context) - "tool sets" → toolsets - "M.C.P." or "M C P" → MCP - "repo memory" → repo-memory (in configuration context) - "cache memory" → cache-memory (in configuration context) - "work flow" → workflow - "timeout minutes" → timeout-minutes - "runs on" → runs-on - "min integrity" → min-integrity (in configuration context) - "mcp gateway" → mcp-gateway - "mcp scripts" → mcp-scripts - "staged mode" → staged-mode - "token weights" → token-weights - "effective tokens" → effective-tokens ### AI Engines - "co-pilot" → copilot - "code x" → codex - "cloud" → claude (when referring to the AI engine) - "gem ini" → gemini (when referring to the AI engine) - "serena" → serena (code intelligence MCP server) ### Commands and Operations - "G.H. A.W." → gh-aw or `gh aw` (depending on context) - "re-compile" → recompile - "work flow dispatch" → workflow_dispatch - "action lint" → actionlint - "ziz more" → zizmor - "poo teen" → poutine - "queue M.D." → qmd ### File Formats and Extensions - "dot M.D." → .md - "dot Y.A.M.L." or "dot Y M L" → .yaml or .yml - "dot lock dot Y M L" → .lock.yml - "jason" → JSON (when referring to format) - "wasm" → WebAssembly or wasm (depending on context) ### Technical Patterns - "A.P.I." → API - "U.R.L." → URL - "H.T.T.P." → HTTP - "H.T.T.P.S." → HTTPS - "S.H.A." → SHA - "C.I." → CI - "G.H." → GH (when referring to GitHub CLI) - "Y.A.M.L." → YAML - "O.I.D.C." → OIDC - "S.A.R.I.F." → SARIF ### Hyphenation Rules Use hyphens for compound modifiers: - "safe outputs" → safe-outputs - "safe inputs" → safe-inputs - "cache memory" → cache-memory - "timeout minutes" → timeout-minutes - "cross repository" → cross-repository - "pull request" → pull-request (when used as adjective) - "mcp gateway" → mcp-gateway - "mcp scripts" → mcp-scripts - "token weights" → token-weights ### Environment Variables Capitalize fully: GITHUB_TOKEN, GH_TOKEN, COPILOT_GITHUB_TOKEN, GH_AW_GITHUB_TOKEN, ANTHROPIC_API_KEY, OPENAI_API_KEY, GEMINI_API_KEY, CLAUDE_CODE_OAUTH_TOKEN, CODEX_API_KEY ### Common Ambiguities - "their/there/they're" → use context to determine correct spelling - "its/it's" → its (possessive), it's (it is) - "your/you're" → your (possessive), you're (you are) ## Clean Up and Improve Text Remove filler words and improve clarity: ### Remove These Filler Words - humm, um, uh, uhh, umm - you know, like, basically, actually, literally - kind of, sort of, I mean, I think - right?, okay?, so yeah, well ### Improve Clarity 1. Remove redundant phrases: - "in order to" → "to" - "at this point in time" → "now" - "due to the fact that" → "because" - "in the event that" → "if" 2. Make text more concise: - Remove unnecessary qualifiers (very, really, quite) - Use active voice instead of passive voice - Replace wordy phrases with simpler alternatives 3. Maintain technical accuracy: - Keep all technical terms from the glossary - Preserve code examples and commands exactly - Don't simplify technical concepts ## Guidelines You do not have enough background information to plan or provide code examples. - do NOT generate code examples - do NOT plan steps - focus on fixing speech-to-text errors and improving text quality - remove filler words (humm, you know, um, uh, like, basically, actually, etc.) - improve clarity and make text more professional - maintain the user's intended meaning