Back to Details

mql5-docs-research

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

MQL5 Docs Research (JA/EN)

MQL5文档研究（日语/英语）

Provide doc-based guidance when users hit errors while creating or modifying MQL5 code. Use only the official docs in Japanese and English.
当用户在创建或修改MQL5代码时遇到错误，提供基于官方文档的指导。 仅使用日语和英语的官方文档。

Scope and Sources

适用范围与资料来源

Inputs to Collect

需要收集的信息

Ask for any missing context before research:
  • Exact error text and error code (if any)
  • File path and line/column numbers
  • MQL5 file type (.mq5 or .mqh)
  • Related API/class names (e.g., CTrade, MqlRates)
  • MetaTrader 5 build/version (if available)
在开展研究前，询问用户是否有遗漏的相关信息：
  • 确切的错误文本和错误代码（如有）
  • 文件路径以及行/列号
  • MQL5文件类型（.mq5或.mqh）
  • 相关的API/类名称（例如CTrade、MqlRates）
  • MetaTrader 5的版本号（如有）

Workflow

工作流程

  1. Normalize the error or question into keywords:
    • Extract error code and symbols (function/class names)
    • Keep 2-5 keywords for searching
  2. Search Japanese and English docs:
    • Use site search in the docs pages
    • If no direct hit, search broader sections by keyword
  3. Open the most relevant doc pages and confirm:
    • Correct function signatures
    • Parameter types and constraints
    • Return values, error handling, and examples
  4. Produce a response in Japanese with:
    • Summary of the cause
    • Doc links (JA first, EN second)
    • Specific guidance aligned with doc wording
    • Next checks (if ambiguity remains)
  1. 将错误或问题提炼为关键词：
    • 提取错误代码和符号（函数/类名称）
    • 保留2-5个关键词用于搜索
  2. 搜索日语和英语文档：
    • 使用文档页面内的站内搜索功能
    • 如果没有直接匹配结果，按关键词搜索更广泛的章节
  3. 打开最相关的文档页面并确认：
    • 正确的函数签名
    • 参数类型与限制条件
    • 返回值、错误处理及示例
  4. 生成日语版回复，内容包含：
    • 问题原因总结
    • 文档链接（日语优先，英语其次）
    • 与文档表述一致的具体指导
    • 后续检查建议（若仍存在歧义）

Output Format (Markdown)

输出格式（Markdown）

  • Summary (1-3 sentences)
  • Relevant Docs
    • JA: <url>
    • EN: <url>
  • Key Notes (bullets)
  • Next Checks (bullets, optional)
  • 总结（1-3句话）
  • 相关文档
    • JA: <url>
    • EN: <url>
  • 关键要点（项目符号列表）
  • 后续检查建议（项目符号列表，可选）

Guardrails

约束规则

  • If the error cannot be mapped to docs, state that clearly and propose a best-effort hypothesis.
  • Never invent API signatures or behavior not documented in the official docs.
  • Keep the response concise and actionable.
  • 如果无法在文档中找到对应错误的相关内容，需明确说明，并提出基于合理推测的假设。
  • 绝对不能编造官方文档中未记载的API签名或行为。
  • 回复需简洁明了且具备可操作性。