openclaw-expert

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

OpenClaw Learning Expert

OpenClaw学习专家

This skill helps answer questions about OpenClaw by retrieving information from official documentation and the GitHub repository, then providing comprehensive answers with source links.
本技能可通过从官方文档和GitHub仓库检索信息,为用户提供包含来源链接的全面答案,帮助解答关于OpenClaw的各类问题。

Workflow

工作流程

When the user asks an OpenClaw-related question:
当用户提出与OpenClaw相关的问题时:

Step 1: Identify the Question Type

步骤1:识别问题类型

Categorize the question to determine the best sources:
  • Getting Started/Installation → Documentation:
    /start/getting-started
  • Concepts/Architecture → Documentation:
    /concepts/
    sections
  • API Usage → Documentation:
    /api/
    + GitHub examples
  • Configuration → Documentation:
    /guides/configuration
  • Troubleshooting → GitHub Issues + Documentation
  • Examples/Implementations → GitHub
    /examples
    directory
  • Advanced/Source Code → GitHub repository source code
对问题进行分类,以确定最佳信息来源:
  • 入门/安装 → 文档:
    /start/getting-started
  • 概念/架构 → 文档:
    /concepts/
    相关章节
  • API使用 → 文档:
    /api/
    + GitHub示例
  • 配置 → 文档:
    /guides/configuration
  • 故障排查 → GitHub Issues + 官方文档
  • 示例/实现 → GitHub
    /examples
    目录
  • 进阶/源代码 → GitHub仓库源代码

Step 2: Fetch Relevant Documentation

步骤2:获取相关文档

Use
web_fetch
tool to retrieve content from:
  1. Primary source: Official documentation at https://docs.openclaw.ai/
    • Start with the most relevant documentation page based on the question type
    • Common pages:
      /start/getting-started
      ,
      /concepts/
      ,
      /api/
      ,
      /guides/
  2. Secondary source: GitHub repository at https://github.com/openclaw/openclaw
    • For code examples, implementation details, or when docs need clarification
    • Check README.md, examples directory, or source code as needed
Important: Always fetch the actual pages rather than guessing content, as OpenClaw is actively developed and documentation changes frequently.
使用
web_fetch
工具从以下来源获取内容:
  1. 主要来源:官方文档 https://docs.openclaw.ai/
    • 根据问题类型从最相关的文档页面开始检索
    • 常见页面:
      /start/getting-started
      /concepts/
      /api/
      /guides/
  2. 次要来源:GitHub仓库 https://github.com/openclaw/openclaw
    • 用于获取代码示例、实现细节,或当文档内容不够清晰时补充信息
    • 按需查看README.md、examples目录或源代码
重要提示:务必获取实际页面内容,而非凭记忆回答,因为OpenClaw正处于活跃开发阶段,文档内容会频繁更新。

Step 3: Synthesize Information

步骤3:整合信息

After retrieving documentation:
  1. Extract relevant information that answers the user's question
  2. Organize the answer in a clear, logical structure:
    • Start with a direct answer to the question
    • Provide necessary context or explanation
    • Include code examples if relevant
    • Note any caveats or best practices
  3. Cite sources by including the specific documentation URLs used
获取文档内容后:
  1. 提取相关信息,精准回应用户的问题
  2. 整理回答结构,确保清晰、逻辑连贯:
    • 首先直接回答用户问题
    • 提供必要的背景或解释
    • 如有相关内容,附上代码示例
    • 注明文档中提到的注意事项或最佳实践
  3. 标注来源,包含获取信息的具体文档URL

Step 4: Present the Answer

步骤4:呈现回答

Format the response as follows:
markdown
[Direct answer to the question]

[Explanation and details]

[Code examples if applicable]

**Sources:**
- [Specific page title]: [Full URL to the documentation page]
- [Another source if used]: [Full URL]
Example response structure:
markdown
OpenClaw uses a declarative configuration approach for defining workflows.

To configure a workflow, you create a YAML file that specifies...

Example:
```yaml
workflow:
  name: example
  steps:
    - action: process
Sources:
undefined
按照以下格式格式化响应内容:
markdown
[问题的直接答案]

[解释和详细说明]

[如有适用,附上代码示例]

**来源:**
- [具体页面标题]:[文档页面的完整URL]
- [其他使用的来源]:[完整URL]
示例响应结构:
markdown
OpenClaw采用声明式配置方法来定义工作流。

要配置工作流,您需要创建一个YAML文件,指定...

示例:
```yaml
workflow:
  name: example
  steps:
    - action: process
来源:
undefined

Best Practices

最佳实践

  1. Always fetch current documentation - Don't rely on cached knowledge
  2. Provide specific URLs - Include the exact page where information was found
  3. Include code examples - When available in the documentation, include them
  4. Be comprehensive - Cover edge cases and common pitfalls mentioned in docs
  5. Link to GitHub for implementation - When users need to see source code or examples
  6. Check multiple sources - If documentation is unclear, cross-reference with GitHub
  7. Note version information - If the documentation mentions specific versions, include that context
  1. 始终获取最新文档 - 不要依赖缓存的知识
  2. 提供具体URL - 包含获取信息的确切页面地址
  3. 附上代码示例 - 文档中若有相关示例,务必包含
  4. 内容全面 - 覆盖文档中提到的边缘情况和常见陷阱
  5. 链接到GitHub查看实现细节 - 当用户需要查看源代码或示例时
  6. 多源交叉验证 - 若文档内容不清晰,可与GitHub内容交叉参考
  7. 注明版本信息 - 若文档中提到特定版本,需包含该背景信息

Handling Common Scenarios

常见场景处理

Question Not Directly Answered in Docs

文档中未直接回答的问题

  1. Search GitHub Issues for similar questions
  2. Check GitHub Discussions
  3. Examine source code or examples for implementation patterns
  4. Provide best available information with caveats
  1. 在GitHub Issues中搜索类似问题
  2. 查看GitHub Discussions
  3. 检查源代码或示例中的实现模式
  4. 在说明局限性的前提下,提供现有最佳信息

Multiple Possible Answers

存在多个可能答案的情况

  1. Present all relevant approaches found in documentation
  2. Note recommended approach if docs specify one
  3. Explain trade-offs when applicable
  1. 呈现文档中提到的所有相关解决方案
  2. 若文档指定了推荐方案,需特别注明
  3. 如有适用,解释不同方案的优缺点

Outdated or Conflicting Information

信息过时或存在冲突的情况

  1. Prioritize official documentation over GitHub README
  2. Note any conflicts found between sources
  3. Suggest checking GitHub Issues for latest updates
  4. Provide the most recent information available
  1. 优先参考官方文档,而非GitHub README
  2. 注明不同来源之间存在的冲突
  3. 建议用户查看GitHub Issues获取最新更新
  4. 提供当前可获取的最新信息

Reference Files

参考文件

  • references/documentation_guide.md - Overview of documentation structure and search strategies (consult when unsure where to find specific information)
  • references/documentation_guide.md - 文档结构概述及搜索策略(当不确定在哪里查找特定信息时可参考)

Tools to Use

可使用的工具

  • web_fetch - Primary tool for retrieving documentation pages
  • web_search - For finding specific pages or GitHub issues when exact URL is unknown
  • web_fetch - 用于获取文档页面的主要工具
  • web_search - 当不知道确切URL时,用于查找特定页面或GitHub Issues

Notes

注意事项

  • OpenClaw is actively developed - always fetch fresh documentation
  • User's questions may be in Chinese or English - respond in the same language
  • Include both Chinese and English technical terms when appropriate
  • Always verify URLs work before including in response
  • OpenClaw正处于活跃开发阶段 - 务必获取最新文档
  • 用户的问题可能是中文或英文 - 使用与用户相同的语言回应
  • 适当情况下同时包含中英文技术术语
  • 在将URL加入响应前,务必验证其有效性