文档同步

其他 社区

技能解读

当前原文的自动摘译,尚未人工审校。

文档位置

Which Key Lazy 项目在以下位置有文档: README.md - 主项目自述文件(使用长名称“Which Key LazyVim-style”) CLAUDE.md - Claude 代码指南(使用长名称“Which Key LazyVim-style”) src/main/resources/META-INF/plugin.xml - 带有描述的插件清单

代码位置

文档引用的关键源文件: src/main/kotlin/lazyideavim/whichkeylazy/ - 所有源代码 gradle.properties - 插件元数据(名称、版本、构建目标) settings.gradle.kts - 项目名称 配置文件:~/.whichkey-lazy.json

核心心态

关键:代码更改后,文档在被证明无罪之前是有罪的。 ❌ 错误的方法:“保守一点,只有在明显错误的情况下才更新” ✅ 正确的方法:“积极发现问题,保守地进行修复” 信任层次结构:在代码库中有效实现(最高事实)

模式A:文档→代码验证

从文档开始,验证代码是否仍然与文档中的内容匹配。步骤: 首先:检查当前代码库状态(阶段 0) 阅读指定的文档文件 提取所有代码引用、功能声明和架构描述

流狐档案 运行与权限由流狐静态检查推断,不代表作者声明或实际测试结果。
领域
通用
作者声明的智能体
未找到明确声明;不据此推断已兼容或已测试
静态检查
88 / 100 · 启发式扫描,不代表运行安全
运行环境证据
未执行;当前没有隔离运行测试证据
作者 / 版本 / 许可证
@brandonkramer · 未声明许可证
上下文用量评级
低消耗
接入复杂程度
即装即用
是否需要外部接口密钥
不需要
兼容的系统
未声明(默认跨平台)
运行环境要求
未检出明确要求
检测到的文件与系统行为
  • 只读
  • 允许写入 / 修改
网络行为
仅限本地
安装命令数
无(仅作为资料)

需要注意: 未声明工具权限范围;实际权限由运行环境决定。

01
第 0 阶段:预分析搜索(首先执行此操作)

在阅读完整文件之前,请运行以下快速搜索以查找危险信号:

02
第 0 步:建立基本事实(关键 - 首先做)

检查包结构:`find src/main/kotlin -name "*.kt"` 检查 git 历史记录:`git log --oneline -10` 检查关键文件:`gradle.properties`、`plugin.xml`、`WhichKeyConfig.kt`

03
第 1 步:了解任务

如果给定文档文件:模式 A(验证文档与代码匹配) 如果给定代码更改:模式 B(更新文档以匹配代码) 如果给定两者:检查代码更改是否影响提到的文档

04
第 2 步:快速模式搜索

从第 0 阶段运行 grep 搜索以查找明显的危险信号比较包名称、类名称、配置引用

05
第三步:详细验证

彻底阅读文档 对于每个声明或代码参考:根据实际代码库进行验证 运行上面相应的检查表

06
第 4 步:分析差异

列出文档和代码之间的差异 评估严重性(严重与次要) 确定是否需要更新

07
第 5 步:根据需要进行更新

编辑文档文件并进行精确的更改解释更改的内容以及原因

讨论

基于 GitHub Discussions。登录 GitHub 即可参与讨论、点赞、订阅更新。