arcgis-docs-lookup
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseArcGIS Docs Lookup
ArcGIS 文档查找
Answer every ArcGIS question from the first-party source that owns it — never a stale mirror, a wrong-product page, or an unverified forum post.
所有ArcGIS相关问题的答案均来自官方一手资源——绝不使用过时的镜像页面、错误的产品页面或未经验证的论坛帖子。
Route to the owning source
定位至官方资源
- developers.arcgis.com — ArcGIS Maps SDK for JavaScript, ArcGIS API for Python, the REST API, and Arcade references.
- developers.arcgis.com/enterprise-sdk — the ArcGIS Enterprise SDK, including Custom Data Feeds (CDF) provider development. A distinct product area from the developer references above — route CDF and Enterprise SDK questions here.
- pro.arcgis.com — ArcGIS Pro, including ArcPy and geoprocessing.
- enterprise.arcgis.com — ArcGIS Enterprise, Portal, and Notebook Server administration and runtime docs.
Never cite ArcMap, ArcCatalog, or ArcGIS Desktop documentation. It describes a retired product whose APIs have diverged from Pro and Enterprise. If a search returns an ArcMap or ArcGIS Desktop page, discard it and find the Pro or Enterprise equivalent.
- developers.arcgis.com — ArcGIS Maps SDK for JavaScript、ArcGIS API for Python、REST API及Arcade的参考文档。
- developers.arcgis.com/enterprise-sdk — ArcGIS Enterprise SDK相关文档,包括自定义数据馈送(CDF)提供商开发内容。这是与上述开发者参考文档不同的独立产品领域——CDF和Enterprise SDK相关问题需导向此处。
- pro.arcgis.com — ArcGIS Pro相关文档,包括ArcPy和地理处理内容。
- enterprise.arcgis.com — ArcGIS Enterprise、Portal及Notebook Server的管理与运行时文档。
**切勿引用ArcMap、ArcCatalog或ArcGIS Desktop文档。**这些文档描述的是已退役产品,其API与Pro和Enterprise版本差异较大。若搜索结果返回ArcMap或ArcGIS Desktop页面,请弃用并查找Pro或Enterprise的对应内容。
Pin the version
固定版本
Enterprise docs are version-scoped by URL path (e.g. ). Pin every Enterprise URL to the target version you are working against — the release the caller named, or the one the user is on. An unversioned or mismatched Enterprise URL is not an acceptable citation.
.../enterprise/11.2/...Enterprise文档通过URL路径区分版本(例如 )。需将所有Enterprise URL固定为你正在使用的目标版本——即调用方指定的版本或当前用户使用的版本。未指定版本或版本不匹配的Enterprise URL不可作为有效引用。
.../enterprise/11.2/...Treat Community as a hypothesis, not a source
社区内容仅作参考,非权威来源
Esri Community, GeoNet, and Stack Exchange threads are leads to verify, never the citation. Trace every claim back to the owning first-party doc before relying on it.
Esri Community、GeoNet及Stack Exchange的帖子仅作为线索需验证,不可直接作为引用依据。在采信任何结论前,需追溯至官方一手文档进行确认。
When the reference page won't render
当参考页面无法渲染时
The ArcGIS API for Python and REST API references on developers.arcgis.com are client-rendered single-page apps. A plain fetch of one of these pages — even at a precise symbol anchor like — returns no usable content, because the symbol table is painted by JavaScript the fetch never runs. This is a tooling failure, not evidence the API is absent. Never downgrade "I couldn't render the reference" into "there is no such API." Instead, fall back to first-party sources that are machine-readable, in order:
arcgis.gis.toc.html#arcgis.gis.Group.notify- Search the owning source's GitHub repo. For the Python API, search — the guide and sample notebooks, and especially the per-version
Esri/arcgis-python-apinotebooks underrelease_notes_*, enumerate classes and methods by name with anchor links back to the reference (this is where a symbol likeguide/02-api-overview/surfaces even though its reference page won't render). Search the repo for the exact symbol name.Group.notify() - Introspect the installed package. When a live environment with the package is available, the package source is what the reference is generated from — read the truth directly with
arcgisorhelp(Group.notify). Use theinspect.signature(...)skill to run it. The equivalent for the JS SDK is thepython-notebookTypeScript declarations shipped on npm.@arcgis/core
Only after these fallbacks come up empty may you report the symbol as unverified — and say "could not verify," not "does not exist," when a client-rendered page was the only thing blocking you.
developers.arcgis.com上的ArcGIS API for Python和REST API参考文档是客户端渲染的单页应用。直接获取这类页面内容——即使是精确到符号锚点的链接,如 ——也无法得到可用内容,因为符号表是由JavaScript渲染的,而获取操作不会执行该脚本。**这是工具层面的问题,并非API不存在的证据。**绝不能将“无法渲染参考页面”等同于“该API不存在”。此时应转而使用以下可机器读取的官方资源,优先级如下:
arcgis.gis.toc.html#arcgis.gis.Group.notify- 搜索官方GitHub仓库。对于Python API,搜索 ——指南和示例笔记本,尤其是
Esri/arcgis-python-api下的各版本guide/02-api-overview/笔记本,会按名称枚举类和方法,并附带指向参考文档的锚点链接(即使参考页面无法渲染,release_notes_*这类符号也会在此处显示)。在仓库中搜索精确的符号名称。Group.notify() - 检查已安装的包。当存在安装了 包的实时环境时,包源码是参考文档的生成依据——可直接通过
arcgis或help(Group.notify)获取真实信息。使用inspect.signature(...)技能执行该操作。JS SDK的等效方式是查看npm上发布的python-notebookTypeScript声明文件。@arcgis/core
只有在这些备用方式均无结果时,才可报告该符号未经验证——且需说明“无法验证”,而非“不存在”,若仅因客户端渲染页面无法加载而受阻。
Match the depth to the question
匹配问题的深度需求
- Quick existence or signature check ("does this class/method/global exist at version N") — read the owning reference page directly and answer inline. No file written.
- Genuine investigation (a migration surface, a breaking-change sweep, synthesis across many pages) — escalate to the skill if it is available, passing these routing and version rules so the background agent obeys them. If
researchis not installed, do the investigation inline against the same first-party sources.research
- 快速存在性或签名检查(“版本N中是否存在此类/方法/全局变量”)——直接查看官方参考页面并在线回答,无需生成文件。
- 深度调研(迁移场景、破坏性变更排查、跨多页面综合分析)——若 技能可用,可升级至该技能处理,并传递上述路由和版本规则,以便后台Agent遵循。若未安装
research技能,则需基于相同的官方资源在线完成调研。research
Done when
完成标准
Every claim is backed by a first-party URL on the correct domain, pinned to the target version wherever the docs are version-scoped, and no ArcMap/Desktop page or unverified Community thread remains as a citation. No "this API does not exist" conclusion rests on a reference page that merely failed to render — that path was exhausted through the GitHub-repo and package-introspection fallbacks first.
所有结论均需由对应域名的官方一手URL支持,版本化文档需固定至目标版本,且无ArcMap/Desktop页面或未经验证的社区帖子作为引用。“该API不存在”的结论不能仅基于参考页面无法渲染——需先穷尽GitHub仓库和包检查的备用方式后才可得出。