AgentSkillsCN

code-examples-sync

代码示例的同步、验证与更新模式。在函数签名变更、API接口修改、最佳实践演进，或示例需要更新时使用。当代码示例过时、示例语法出错、导入语句需更新、文档片段需验证，或需要在各文档间保持示例一致性时，该模式将被触发。

SKILL.md
--- frontmatter
name: code-examples-sync
description: Code example synchronization, verification, and update patterns. Use when function signatures change, API interfaces are modified, best practices evolve, or examples need updates. Triggers on code example outdated, example syntax errors, updating imports, verifying documentation snippets, and maintaining example consistency across docs.
license: Complete terms in LICENSE.txt

Code Example Synchronization

Maintain code examples in documentation that stay synchronized with actual code.

Skill Paths

  • •Workspace skills: .github/skills/
  • •Global skills: C:/Users/LOQ/.agents/skills/

Activation Conditions

Use this skill when:

  • •Function signatures or parameters change
  • •API interfaces are modified
  • •Best practices evolve (deprecated patterns emerge)
  • •Code examples become outdated
  • •Imports or dependencies change

Verification Checks

See Code Example Verification for:

  • •Checking examples compile/run correctly
  • •Verifying imports are up to date
  • •Testing example output matches documentation
  • •Ensuring consistent syntax across examples

Update Patterns

When code changes affect examples:

  1. •

    Function signature changes: Update all snippets using the function, verify examples compile, update imports if needed

  2. •

    API interface changes: Update request/response examples, revise client code examples, update SDK usage examples

  3. •

    Best practice evolution: Replace outdated patterns, update to current recommended approaches, add deprecation notices for old patterns

Quality Checklist

  • • All code examples compile/run successfully
  • • Imports and dependencies are current
  • • Output matches documented results
  • • Syntax is consistent across language
  • • Error handling is demonstrated where applicable