技能 doc-sync
📦
doc-sync
内容修订 r2 安全 ⚙️ 外部命令
使 IdeaVim 文档与代码保持同步
IdeaVim 代码变更可能会让文档示例过时。此技能帮助将文档与当前 API、git 历史记录和可运行实现进行比较。
支持: Claude Codex Code(CC)
使用我的智能体安装
将此请求复制给你的智能体，其中包含权威 Skill 页面和清单。
智能体请求
Review the Skillstore skill "doc-sync" from https://skillstore.io/skills/jetbrains-doc-sync.md and its manifest at https://skillstore.io/api/skills/jetbrains-doc-sync/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.你的智能体仍应展示其计划，并按安全策略请求必要确认。
Agent 可读资源
当 AI Agent、爬虫或脚本需要干净上下文，而不是读取完整页面时，请使用这些链接。
测试它
正在使用“doc-sync”。 根据当前源代码检查一个映射文档。
预期结果:
- 已检查的文件包括映射文档和相关 Kotlin 实现文件。
- 在一个文档示例中发现了一个过时的参数名称。
- 文档已更新为匹配当前 API，未进行仅风格性的编辑。
正在使用“doc-sync”。 源文件变更后审查文档。
预期结果:
- 最近的 git 历史记录显示有一个映射选项已被移除。
- 两个文档引用仍在使用旧选项名称。
- 这两个引用均已更新，并留下了一条有歧义的行为说明供维护者审查。
正在使用“doc-sync”。 运行大范围文档偏移审计。
预期结果:
- 审计检查了文档文件中的签名、映射示例和文件引用。
- 在已审查的文件中未确认存在损坏的示例。
- 报告列出了用作事实依据的实现文件。
安全审计
安全v9 • 2026/7/23 打开版本化报告
All 18 backtick findings are false positives caused by Markdown formatting or documented, read-only search and Git commands. The network-scanning finding is also false because nmap appears only as text inside a grep pattern.
1
已扫描文件
276
分析行数
0
复核项
0
已忽略误报
风险因素
最新一次完成的静态与语义审计未检测到已确认的安全发现。这并不能证明该 Skill 没有副作用。
审计者: codex 查看审计历史 →
分享与引用此报告
分享版本化评估报告、中性徽章、嵌入卡片和引用。Skillstore 只报告证据，不判断该 Skill 是否安全。
复制报告链接
https://skillstore.io/skills/jetbrains-doc-sync/audits/9?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown 徽章
[](https://skillstore.io/skills/jetbrains-doc-sync?utm_source=security_passport_badge)HTML 徽章
<a href="https://skillstore.io/skills/jetbrains-doc-sync?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/jetbrains-doc-sync/security.svg" alt="Skillstore security assessment" loading="lazy"></a>嵌入卡片
<iframe src="https://skillstore.io/embed/skills/jetbrains-doc-sync.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>学术引用 (APA · BibTeX · CFF)
APA 引用
JetBrains. (2026). doc-sync security audit report (audit version 9) [Author version unspecified]. Skillstore. https://skillstore.io/skills/jetbrains-doc-sync/audits/9BibTeX 引用
@techreport{jetbrains-jetbrains-doc-sync-2026,
author = {JetBrains},
title = {doc-sync security audit report (audit version 9)},
institution = {Skillstore},
year = {2026},
number = {9},
url = {https://skillstore.io/skills/jetbrains-doc-sync/audits/9},
note = {Author version unspecified}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "doc-sync security audit report (audit version 9)"
version: "unspecified"
type: report
authors:
- name: "JetBrains"
date-released: "2026-07-23"
url: "https://skillstore.io/skills/jetbrains-doc-sync/audits/9"
identifiers:
- type: other
value: "skillstore:jetbrains-doc-sync:audit:9"
description: "Skillstore immutable audit report identifier"
Skillstore 评分
评分依据 证据置信度: 高 55
架构
85
可维护性
87
内容
70
社区
83
规范符合性
你能构建什么
API 变更后审查文档
在 Kotlin API、类或参数变更后检查受影响的 IdeaVim 文档。
发布前验证示例
在发布版本前，将文档示例与可运行实现进行比较。
审计大范围文档偏移
扫描文档中的过时映射、签名和文件引用。
试试这些提示
检查单个文档
检查 doc/ideavim-mappings.md 是否与当前 IdeaVim 代码匹配。报告任何过时示例，并仅更新已确认的问题。
审查已变更的文件
我更改了 MappingScope.kt。查找相关文档，将示例与当前实现进行比较，并仅在行为或 API 用法发生变化时更新文档。
验证已删除的 API 引用
使用最近的 git 历史记录识别已移除或已弃用的映射 API。然后检查文档中的陈旧引用，并准备精确更新。
审计所有文档
检查所有 IdeaVim 文档中的过时签名、参数名称和映射示例。优先处理会破坏用户代码的问题。
最佳实践
- 先查看当前可运行代码，再信任现有文档。
- 编辑示例前检查删除项和重命名的参数。
- 进行范围较窄的文档更改，并保留现有风格。
避免
- 不要仅因为措辞可以更好听就更新文案。
- 不要依赖文档作为事实来源。
- 除非当前代码证明其错误，否则不要删除有用的上下文。
常见问题
此技能是为哪个项目设计的？
它专为 IdeaVim 仓库及其文档结构设计。
它可以更新文档文件吗？
可以。当代码审查确认文档已过时时，它会指导进行有针对性的编辑。
它会自动运行命令吗？
它会建议用于仓库分析的本地 grep、find 和 git 命令。执行由用户或代理环境控制。
应该用什么作为事实依据？
应将当前可运行的实现文件和 API 定义视为最高权威。
它能检查每个文档文件吗？
可以，但大范围审计需要更多时间，并且仍需要源文件进行比较。
它会进行仅风格性的文档更改吗？
不会。该工作流建议仅针对已确认的准确性问题进行编辑。