命令文档模式

# 命令文档模式 创建自文档化、可维护且具有出色用户体验的命令的策略。 ## 概述 文档完善的命令更易于使用、维护和分发。文档应嵌入在命令本身中，使用户和维护者能够立即访问。 ## 自文档化命令结构 ### 完整命令模板 markdown --- description: 60 字符以内清晰、可操作的描述 argument-hint: [arg1] [arg2] [optional-arg] allowed-tools: Read, Bash(git:*) model: sonnet --- # 命令实现 [在此处放置命令提示词内容...] [解释将发生什么...] [引导用户完成步骤...] [提供清晰的输出...] ### 文档注释部分 **PURPOSE**：命令存在的原因 - 解决的问题 - 用例 - 何时使用与何时不使用 **USAGE**：基本语法 - 命令调用模式 - 必需参数与可选参数 - 默认值 **ARGUMENTS**：详细参数文档 - 每个参数的描述 - 类型信息 - 有效值/范围 - 默认值 **EXAMPLES**：具体用法示例 - 常见用例 - 边界情况 - 预期输出 **REQUIREMENTS**：先决条件 - 依赖项 - 权限 - 环境设置 **RELATED COMMANDS**：关联 - 类似命令 - 互补命令 - 替代方案 **TROUBLESHOOTING**：常见问题 - 已知问题 - 解决方案 - 变通方法 **CHANGELOG**：版本历史 - 何时发生了什么变化 - 突出显示重大变更 - 迁移指南 ## 内联文档模式 ### 注释部分 m