Files
Claude-Code-Workflow/.claude/skills/command-guide/templates/issue-diagnosis.md

6.8 KiB
Raw Blame History

name, about, labels
name about labels
交互式诊断 通过结构化流程快速定位问题 diagnosis

交互式诊断模板

本模板通过结构化的问题引导,帮助您快速定位问题根源。请按顺序完成各个部分。

📋 第一步:问题分类

  • 命令执行失败或报错
  • 命令执行成功但结果不符合预期
  • 不知道该使用哪个命令
  • 配置或环境问题
  • 工作流程问题
  • 性能或超时问题
  • 其他: __________

📜 第二步:完整执行流程记录

关键: 详细记录您的完整操作历史,这是快速定位问题的基础

2.1 执行环境

# 当前工作目录
pwd

# 相关环境变量(如适用)
echo $CLAUDE_WORKFLOW_SESSION
echo $PROJECT_ROOT

工作目录: 相关环境变量:

2.2 完整命令历史

# 命令 1 - [简短描述此命令的目的]
# 示例: /workflow:plan --agent "implement user authentication"

# 输出/结果:
# [请粘贴输出,注意删除敏感信息]

# 命令 2 - [简短描述此命令的目的]


# 输出/结果:


# 命令 3 - [简短描述此命令的目的]


# 输出/结果:

隐私保护指南:

  • 可以包含: 命令名称、参数结构、错误代码
  • 应该移除: API密钥、密码、真实文件路径、个人身份信息
  • 💡 替换示例:
    • /real/path/project/path/to/project
    • user@email.comuser@example.com
    • sk-abc123xyzsk-***

2.3 相关文件状态

  • 涉及的文件路径:
  • 文件是否存在: [ ] 是 / [ ] 否
  • 文件权限:
  • 最近修改时间:

🔍 第三步:交互式问题定位

3.1 命令执行问题诊断

基础检查

  • 命令名称拼写正确
  • 所有必需参数都已提供
  • 参数格式符合文档要求
  • 路径使用正确的格式Windows/Linux
  • 具有执行命令所需的权限

环境检查

  • 在正确的目录下执行命令
  • 相关依赖工具已安装(如 git, node, gemini, codex
  • 环境变量配置正确
  • 没有其他进程占用相关资源

上下文检查

  • Workflow session 状态正常(如适用)
  • 相关配置文件存在且格式正确
  • 前置步骤已完成
  • 没有冲突的并发操作

3.2 结果不符预期诊断

期望结果:

实际结果:

差异分析:

  • 结果格式不同
  • 内容缺失或多余
  • 数据内容错误
  • 文件生成位置错误
  • 其他: __________

可能原因:

  • 对命令功能的理解有误
  • 参数配置不当
  • 输入数据格式问题
  • 工作流状态不匹配
  • 其他: __________

3.3 使用方法不确定诊断

您想要实现的目标:

您已经查看的文档:

  • getting-started.md
  • workflow-patterns.md
  • cli-tools-guide.md
  • 特定命令文档: __________
  • 其他: __________

您已经尝试的方法: 1. 2. 3.

具体的困惑点:

  • 不知道用哪个命令
  • 不理解参数含义
  • 不清楚执行顺序
  • 不知道如何组合使用
  • 其他: __________

🔄 第四步:决策树导航

graph TD
    A[开始诊断] --> B{命令是否执行?}
    B -->|是| C{结果是否符合预期?}
    B -->|否| D{是否有错误信息?}

    C -->|是| E[可能是理解偏差<br/>查看文档核对预期]
    C -->|否| F{结果是部分正确?}

    D -->|是| G[根据错误信息分类]
    D -->|否| H[检查命令拼写和语法]

    F -->|是| I[检查参数配置]
    F -->|否| J[检查输入数据和环境]

    G --> K{错误类型?}
    K -->|权限错误| L[检查文件权限和执行权限]
    K -->|文件未找到| M[检查路径和工作目录]
    K -->|参数错误| N[核对命令文档]
    K -->|超时错误| O[检查网络和资源]

    E --> P[参考: getting-started.md]
    I --> Q[参考: cli-tools-guide.md]
    J --> R[参考: troubleshooting.md]
    L --> S[检查清单 3.1 - 基础检查]
    M --> S
    N --> Q
    O --> T[参考: troubleshooting.md - 性能问题]

根据决策树,您的问题可能属于:

💡 第五步:自助解决尝试

已尝试的解决方案

尝试 1:

  • 方案:
  • 结果: [ ] 成功 / [ ] 失败 / [ ] 部分成功
  • 详细说明:

尝试 2:

  • 方案:
  • 结果: [ ] 成功 / [ ] 失败 / [ ] 部分成功
  • 详细说明:

尝试 3:

  • 方案:
  • 结果: [ ] 成功 / [ ] 失败 / [ ] 部分成功
  • 详细说明:

📞 第六步:寻求帮助

核心问题总结

卡住的具体环节

最重要的疑问

紧急程度

  • 紧急 - 阻碍关键工作进展
  • 重要 - 影响工作效率但有临时方案
  • 一般 - 希望改进但不紧急

📎 附加信息

系统信息

  • 操作系统: Windows / Mac / Linux
  • OS 版本:
  • Claude Code 版本:
  • 相关工具版本:
    • Git:
    • Node:
    • Gemini CLI:
    • Codex:
    • 其他:

相关文件

  • 命令输出日志
  • 配置文件内容
  • 错误截图
  • Workflow session 文件
  • 其他: __________

参考链接


提交前检查清单

提交此诊断前,请确认:

  • 已完整填写"完整执行流程记录"(第二步)
  • 已完成至少一个诊断清单(第三步)
  • 已尝试至少 2 种解决方案(第五步)
  • 已清晰总结核心问题(第六步)
  • 已附加必要的系统信息和日志

诊断日期: 提交人: