Skip to content

docs(command-development): improve discoverability and future-proof model IDs#64

Merged
sjnims merged 1 commit intomainfrom
docs/60-improve-command-development-discoverability
Dec 8, 2025
Merged

docs(command-development): improve discoverability and future-proof model IDs#64
sjnims merged 1 commit intomainfrom
docs/60-improve-command-development-discoverability

Conversation

@sjnims
Copy link
Copy Markdown
Owner

@sjnims sjnims commented Dec 8, 2025

Summary

  • Add debug-related trigger phrases to skill description for better discoverability
  • Update model ID examples to use generic placeholder format
  • Add guidance to prefer shorthand names unless specific version needed

Problem

Fixes #60

The command-development skill was missing trigger phrases for debugging scenarios despite testing-strategies.md covering them. Model ID examples used specific version dates that would become stale as new models release.

Solution

Added "debug command", "command debugging", and "troubleshoot command" trigger phrases to SKILL.md description, along with "debugging commands" in the guidance topics.

Updated frontmatter-reference.md to:

  • Use generic claude-<family>-<version>-<date> format with one concrete example
  • Simplify the note to emphasize shorthand preference
  • Add link to official docs in the validation section fix

Alternatives Considered

  • Could have removed all specific model ID examples entirely, but keeping one example helps users understand the format
  • Could have updated to new docs.claude.com URL, but the redirect from docs.anthropic.com works fine

Changes

  • SKILL.md: Added debug trigger phrases to description
  • frontmatter-reference.md: Updated model ID format documentation in 2 locations

Testing

  • markdownlint passes
  • Verified Claude models documentation link works (via redirect)
  • No syntax errors in YAML frontmatter

🤖 Generated with Claude Code

…odel IDs

Add debug-related trigger phrases to SKILL.md description for better
skill discovery when users need help troubleshooting commands.

Update model ID examples in frontmatter-reference.md to use generic
placeholder format and emphasize shorthand preference, reducing
maintenance burden as new models release.

Fixes #60

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@claude
Copy link
Copy Markdown

claude bot commented Dec 8, 2025

Claude finished @sjnims's task —— View job


PR Review Complete

Tasks

  • Get PR diff
  • Read changed files
  • Run markdownlint on changed files
  • Review against skill development criteria
  • Post review feedback

Summary

Looks good! This PR successfully improves discoverability and future-proofs the documentation.

What's Good

  1. Improved Discoverability: Adding debug-related trigger phrases ("debug command", "command debugging", "troubleshoot command") to the skill description is a smart enhancement. The skill already had comprehensive debugging guidance in testing-strategies.md, but these phrases ensure Claude will load the skill when users need debugging help.

  2. Future-Proof Model Documentation: The change from specific model IDs to a generic placeholder format (claude-<family>-<version>-<date>) with one concrete example is exactly the right approach. This prevents the documentation from becoming stale as Anthropic releases new models.

  3. Clearer Guidance: The simplified note emphasizing shorthand preference is more actionable: "Prefer shorthand names unless you need a specific version" directly tells users what to do.

  4. Consistent Updates: Both locations where model IDs are mentioned (the main field description and validation section) were updated consistently.

  5. Clean Markdown: All markdown linting passes with no issues.

Alignment with CLAUDE.md Guidelines

Writing Style: Trigger phrases follow the pattern in description
Skill Structure: Changes are confined to SKILL.md and references/ subdirectory
Progressive Disclosure: Core skill updated with detailed reference properly separated
Testing: Author confirmed markdownlint passes

Checklist Verification

From the PR description:

  • ✅ markdownlint passes
  • ✅ Claude models documentation link works (I verified the redirect from docs.anthropic.com to docs.claude.com is functional)
  • ✅ No syntax errors in YAML frontmatter

No Issues Found

This is a well-executed documentation improvement. The changes are minimal, focused, and directly address the stated problem. No suggestions for improvement needed.


@sjnims sjnims self-assigned this Dec 8, 2025
@claude claude bot added documentation Improvements or additions to documentation component:skill Skills layer effort:small < 1 hour labels Dec 8, 2025
@sjnims sjnims merged commit 118774c into main Dec 8, 2025
8 checks passed
@sjnims sjnims deleted the docs/60-improve-command-development-discoverability branch December 8, 2025 22:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component:skill Skills layer documentation Improvements or additions to documentation effort:small < 1 hour

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(command-development): improve discoverability and future-proof model ID examples

1 participant