Dictation Instructions

# 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/agents
.github/aw
.github/aw/imports
.github/workflows
.lock.yml
.md
access
accessible
action
action-mode
action-pins.json
action-repo
action-version
actionlint
actions
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
active
actor
actual
add-comment
add-labels
add-reviewer
add-wizard
additional
add_comment
add_labels
admin
after_run_id
agentic
agentic-workflows
agentics
agents
agent_output.json
alerting
alerts
allow
allowed
allowed-domains
allowed-extensions
allowed-github-references
allowed-labels
allowed-pull-request-repos
allowed-reasons
allowed-repos
allowlist
analysis
ANTHROPIC_API_KEY
api.github.com
apiKey
append
append-only-comments
apply
approval
archie
architecture
args
array
artifact
artifacts
assign
assign-milestone
assign-to-agent
assign-to-bot
assign-to-user
assignee
assignees
assignment
ast-grep
audit
audit-workflows
audits
auth
authentication
author
autofix-code-scanning-alert
automated
automatic
automation
automation-enabled
availability
aw-patch
aw.patch
awf
AWF_HOST_PATH
background
banner
base-branch
bash
before_run_id
bi-weekly
blob
blocked
board
boards
body
boolean
boolean-field
branch
branch-name
branch-prefix
branches
branch_name
breaking
breaking-change
breaking-change-checker
brotli
bug
build
builds
bun
cache
cache-key
cache-memory
cached
caches
capabilities
capture
category
category-filter
changes
characters
chart
charts
charts-with-trending
chatops
checkout
checks
choice
ci-doctor
ci-failure-doctor
claude
cleanup
close-discussion
close-issue
close-older-issues
close-pull-request
closed
close_older
cluster
code-scanning
codex
coding
coding-agent
collaboration
collection
command
commands
comment
comment-body
comment-thread
comment_id
comment_repo
commit
commit-changes
commits
compile
compile-time
compile-workflow
compiled
compiled_file
compiler
compileWorkflow
completion
compliance
component
component-spec
components
conclusion
conclusion-check
concurrency
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
copilot-pr-data-fetch
copilot-pr-nlp-analysis
copilot-requests
copilot-session-insights
copilot-swe-agent
COPILOT_GITHUB_TOKEN
copy-from
core
count-limit
coverage
create-agent-session
create-code-scanning-alert
create-discussion
create-issue
create-project
create-project-status-update
create-pull-request
create-pull-request-review-comment
create_discussion
create_fields
create_issue
create_project
create_pull_request
create_pull_request_review_comment
create_views
creation
credentials
criteria
cron
cross-repo
cross-repository
custom
custom-agent
customSchemas
customServerConfig
daily
daily-accessibility-review
daily-backlog-burner
daily-file-diet
daily-ops
daily-perf-improver
daily-qa
daily-repo-status
daily-secrets-analysis
daily-team-status
daily-test-improver
daily-workflow-updater
dart
data-analysis
data-ops
database
datadog
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
discussions
discussion_comment
discussion_number
dispatch
dispatch-ops
dispatch-workflow
dispatched
dispatching
docker
documentation
domains
dotnet
download
downloaded_files
downstream
draft
duplicate
duplicate-code-detector
echo-command
ecosystem
edit
elixir
empty
enabled
encoding/json
endpoints
end_date
enforce
enforcement
engine
engine-config
engine.concurrency
engine.env
engines
entity
entrypoint
entrypointArgs
environment
environment-variables
erlang
error
errors
event-filter
event-trigger
events
example.com
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
flag
flags
fmt
footer
footer-install
footer-text
force-push
force-update
forks
formatted
frontmatter
frontmatter-field
function
functionality
functions
fuzzy
FUZZY:BI-WEEKLY
FUZZY:DAILY
FUZZY:HOURLY
FUZZY:TRI-WEEKLY
FUZZY:WEEKLY
gateway
gateway.apiKey
gatewayVersion
GEMINI_API_KEY
generate
generate-report
generated
generation
get_file_contents
get_me
get_project_structure
get_repository
get_symbols_overview
get_symbol_definition
get_teams
get_team_members
get_user
gh-aw
GH_AW_ACTION_MODE
GH_AW_AGENT_OUTPUT
GH_AW_AGENT_TOKEN
GH_AW_GITHUB_MCP_SERVER_TOKEN
GH_AW_GITHUB_TOKEN
GH_AW_PROJECT_GITHUB_TOKEN
GH_AW_PROMPT
GH_AW_SAFE_OUTPUTS
GH_AW_SAFE_OUTPUTS_PORT
GH_AW_SAFE_OUTPUTS_STAGED
GH_TOKEN
git-branch
git-commit
git-diff
git-status
github
github-actions
github-app
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
githubnext
githubnext/agentics
GITHUB_ACTIONS
GITHUB_ACTOR
GITHUB_PERSONAL_ACCESS_TOKEN
GITHUB_REPOSITORY
GITHUB_TOKEN
GITHUB_WORKFLOW
global
glossary
golang
googleapis
GOROOT
grumpy-reviewer
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
ic_kwDOABCD123456
identifier
identifiers
if-condition
implement
implementation
implements
import-path
imported
imports
incremental
injection-protection
input
input-field
input-validation
inputs
inspect
install
install-gh
installation
instructions
integration
interactive-mode
interface
isolation
issue
issue-ops
issue-triage
issueops
issues
issue_comment
issue_number
iterations
java
javascript
job-output
jobs
jq
json
json-schema
keys
keyword
keyword-search
knowledge
label
label-filter
label-ops
labeled
labeling
labelops
labels
language
language-detection
latest
layer
libraries
limit
limit-per-run
limits
line
lines
linking
load
local
lock
lock-file
lockdown
lockdown-mode
logic
logs
loops
machine
main
maintainer
management
managing
manual
manual-approval
manually
markdown
match
matching
max-file-count
max-file-size
maximize
mcp
mcp-gateway
mcp-inspect
mcp-list
mcp-registry
mcp-server
mcp-servers
mechanism
mechanisms
member
memory
mention
merge
messages
metadata
metadata-read
migrate
milestone
minimal
mode
module
modules
monday
monitoring
monthly-report
multi-repo
multirepo
multirepoops
my-workflow
myorg
needs.activation
needs.activation.outputs.body
needs.activation.outputs.text
needs.activation.outputs.title
network
network.allowed
network.firewall
nightly-run
node
none
noop
null
on-demand
open-telemetry
OPENAI_API_KEY
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
perl
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
prepend
preview.first_item
preview.item_count
preview.schema
pre_activation
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
protection
protocol
provider
public
public_repo
pull-request-repo
pull-requests
pull_number
pull_request
pull_requests
pull_request_comment
pull_request_number
pull_request_review_comment
pull_request_target
purpose
push-ref
push-to-branch
push-to-pull-request-branch
py
python
python3
quality
quality-gate
query
quick-start
ranges
rate
rate-limit
rate-limiting
raw.githubusercontent.com
react
react-emoji
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
reporting
report_diagnostics_to_pull_request
repos
repository
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
roadmap-tracking
roles
ruby
run-context
run-failure
run-name
run-started
run-success
runner
running
runs
runs-on
runtime
runtime-env
runtimes
run_id_or_url
rust
safe
safe-inputs
safe-inputs-mode-removal
safe-inputs.mode
safe-mode
safe-output-app
safe-outputs
safe-outputs.app
safe-outputs.env
safe-outputs.footer
safe-outputs.jobs
safe-outputs.messages
safe-outputs.staged
safe-outputs.threat-detection
safe_outputs
sandbox
sandbox-agent-false-removal
sandbox.agent.env
sandbox.agent.mounts
sandbox.mcp.env
sanitized
scale
scenarios
schedule
schedule-cron
scheduled
schedules
schema
schema-consistency-checker
schemas
scope
scout
script
script-step
scripts
search
secret-key
secret-masking
secrets
security
security-events
semantic
semantic-function-refactor
sensitive
separate
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
specfile
specifications
specified
specifies
specify
specVersion
staged
staged-description
staged-title
staging
stale
standard
startupTimeout
start_date
state
states
static
status-update-id
stdio
stop-after
strict
string
structured
sub-issue-closer
sub-issues
submit-pull-request-review
submit_pull_request_review
sub_issue_number
summary
system
tavily
tavily-search
technical-doc-writer
template
template-file
temporary-id
temporary_id
terraform
testing
timeout
timeout-minutes
timeout-minutes-migration
timeout_minutes
timestamp
timezone
timezone-offset
title-prefix
todo
tokens
toolsets
toolTimeout
tracker-id
tracking
tracking-issue
transform
translation
tri-weekly
trial
trials
trigger
trigger-event
triggers
trusted
trusted-domain
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
update_issue
update_project
upgrade
upload-asset
upload_asset
users
utc-5
utc-7
utc-8
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
w3c-specification-writer
wasm_exec.js
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
workflows
workflows/
workflow_dispatch
workflow_file
workflow_file_path
workflow_name
workflow_run
workspace
write-all
write-permission
yaml
YYYY-MM-DD
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

### AI Engines
- "co-pilot" → copilot
- "code x" → codex
- "cloud" → claude (when referring to the AI engine)

### 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

### 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)

### 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

### 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)

### Environment Variables
Capitalize fully: GITHUB_TOKEN, GH_TOKEN, COPILOT_GITHUB_TOKEN, GH_AW_GITHUB_TOKEN, ANTHROPIC_API_KEY, OPENAI_API_KEY, GEMINI_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