官方目录级审计¶
本页记录中文文档与 JetBrains 官方 IntelliJ Platform Plugin SDK 目录的目录级对照。它和 官网主题覆盖对照表 的区别是:覆盖表按中文章节维护主线主题,本页按官方 sitemap 检查是否存在整类遗漏。
核对日期:2026-06-18。官方 welcome.html 页面构建时间为 2026-06-17,官方 sitemap.xml 本次解析得到 402 个 IntelliJ SDK 页面。
审计方法¶
- 抓取
https://plugins.jetbrains.com/docs/intellij/sitemap.xml。 - 提取所有
https://plugins.jetbrains.com/docs/intellij/*.html页面。 - 按文件名和官方主题聚类,而不是要求中文文档逐页翻译。
- 对每个主题簇标记:深入覆盖、合并覆盖、参考覆盖、待专项展开。
- 对 API 列表、历史变更列表、产品扩展点列表等页面,优先作为参考来源收录,不强行写成教程章节。
审计结论¶
当前中文文档已经覆盖插件开发主路径:项目创建、plugin.xml、Action、Service、PSI、编辑器能力、线程、测试、发布、兼容依赖、扩展点、UI、Execution、项目模型、自定义语言、导航重构、XDebugger、VFS/索引、Remote Development、Marketplace、Gradle 2.x、CI、产品 API 和源码导读。
官方目录级审计发现,仍有若干“细分主题簇”值得后续专项展开。它们不是主路径阻塞项,但如果目标是接近官方目录的完整度,应按优先级逐步补齐。
主题簇状态¶
| 官方主题簇 | 代表官方页面 | 当前中文状态 | 后续动作 |
|---|---|---|---|
| 入门、插件类型、项目创建 | welcome.html, plugins-quick-start.html, creating-plugin-project.html, plugin-types.html |
深入覆盖 | 按官方版本更新即可 |
| Gradle 2.x 构建系统 | tools-intellij-platform-gradle-plugin*.html |
深入覆盖 | 定期核对插件版本、任务和 DSL |
| plugin.xml、依赖、扩展点、监听器 | plugin-configuration-file.html, plugin-dependencies.html, plugin-extensions.html, plugin-listeners.html |
深入覆盖 | 补充更多 descriptor 示例即可 |
| Action System | action-system.html, creating-actions-tutorial.html, grouping-actions-tutorial.html |
深入覆盖 | 可补更多 update thread 和 action group 示例 |
| Service、状态持久化、Disposer | plugin-services.html, persisting-state-of-components.html, disposers.html |
合并覆盖 | 建议补一章生命周期/Disposer 深水区 |
| PSI、References、UAST | psi*.html, references-and-resolve.html, uast.html |
深入覆盖 | Kotlin/UAST 可继续增加案例 |
| Code Insight 主线 | code-completion.html, code-inspections.html, quick-fix.html, annotator.html, inlay-hints.html, documentation.html, code-intentions.html, live-templates.html, postfix-templates.html |
深入覆盖 | 后续可补 Spell Checking 和更多平台内置示例 |
| 自定义语言支持 | custom-language-support*.html, lexer, parser, formatter, commenter, folding |
深入覆盖主线 | 需补 commenter/folding/documentation 的专项测试页 |
| 编辑器、文档、VFS | editor*.html, documents.html, virtual-file*.html |
合并覆盖 | 可补 editor events、Document/VirtualFile 同步专题 |
| VFS、索引、Stub | file-based-indexes.html, stub-indexes.html, indexing-and-psi-stubs.html |
深入覆盖 | 定期补性能和 Dumb Mode 案例 |
| Workspace Model / Project Model | workspace-model*.html, project-model.html |
深入覆盖 | 后续按第三方自定义 entity 支持状态维护 |
| External System / Project Wizard / Facet | external-system-integration.html, project-wizards-intro.html, facet.html |
合并覆盖 | 建议补“项目导入和 Wizard”专题 |
| Execution / Run Configuration | execution.html, run-configurations.html, execution-contexts.html |
深入覆盖 | 可补 execution contexts 细节 |
| XDebugger | API 源码、Java debugger 源码 | 深入覆盖 | 后续可加入 DAP 示例工程 |
| Testing / Fixtures / Integration Tests | testing-plugins.html, tests-and-fixtures.html, integration-tests*.html |
深入覆盖 | 后续按 Starter/Driver API 变化维护 |
| Threading / Coroutine | threading-model.html, coroutine-*.html, background-processes.html |
深入覆盖 | 后续按 2024.2+ execution context API 变化维护 |
| Remote Development / Split Mode | split-mode*.html, remote-procedure-calls.html, frontend-backend-shared-apis.html |
深入覆盖主线 | 需补 RPC DTO 和 plugin management in split mode |
| UI Guidelines / UI Components | ui-guidelines-welcome.html, components.html, button.html, input-field.html, window-sizes.html, accessibility.html 等 |
深入覆盖 | 后续随官方组件页变化补充组件细则 |
| Themes | themes-getting-started.html, theme-structure.html, themes-customize.html |
深入覆盖 | 后续按主题 key 和 Marketplace 规则变化维护 |
| Marketplace / Publishing / Signing | publishing-plugin.html, plugin-signing.html, plugin-icon-file.html |
深入覆盖 | 按 Marketplace 规则变化更新 |
| Product-specific APIs | idea.html, webstorm.html, pycharm.html, data-grip.html, clion.html, rider.html |
合并覆盖 | 产品扩展点列表作为参考,不逐页翻译 |
| Extension Point Lists | *-extension-point-list.html |
参考覆盖 | 保持链接,不写成教程 |
| API changes / Notable API | api-changes-list*.html, api-notable*.html |
合并覆盖 | 每个 IDE 年度版本发布后复核 |
| JCEF / Terminal / VCS / Trusted Projects | embedded-browser-jcef.html, embedded-terminal.html, vcs-integration-for-plugins.html, trusted-projects.html |
深入覆盖 | 后续按 Terminal experimental API 和安全模型变化维护 |
| Live Templates / Postfix Templates | live-templates.html, postfix-templates.html |
深入覆盖 | 后续可补更多真实语言插件示例 |
| Spell Checking / Documentation / Inlay Hints | spell-checking.html, documentation-provider.html, inlay-hints.html |
合并覆盖 | Documentation 和 Inlay 已专项覆盖,Spell Checking 可后续补充 |
| PolySymbols / Web Symbols | polysymbols*.html |
参考覆盖 | Web/前端插件需要时补专项 |
| SDK 文档贡献、风格、Code of Conduct | intellij-sdk-docs-original-*.html, sdk-style.html |
不展开 | 作为贡献参考即可 |
后续优先级¶
中优先级:
- 暂无。本轮审计列出的中高优先级专项缺口已经补齐。
低优先级:
- 产品扩展点列表逐项中文化。
- 历史 API changes 逐年翻译。
- SDK 文档贡献规范和写作风格。
维护规则¶
- 每次官方 sitemap 的页面数量明显变化时,更新本页的页面数量和主题簇。
- 如果新增官方页面属于已覆盖主题,加入覆盖表来源即可。
- 如果新增官方页面形成新主题簇,加入“后续优先级”。
- 对于 API 列表和产品扩展点列表,只在中文文档中保留入口,不做逐项翻译。
- 任何新增章节完成后都必须运行
mkdocs build --strict --site-dir site。