DSH Plugins
返回列表
⚙️

proj-doc-builder

工作流 更新于 2026.11.05

在终端中运行以下命令:

dsh plugin install walvka-code/proj-doc-builder

将以下提示词粘贴到 DeepSeek Harness 对话框中:

在 DeepSeek Harness 中打开 Plugins → More → Custom plugin markets → Discover,添加包含 https://github.com/walvka-code/proj-doc-builder 对应市场的索引后,安装 proj-doc-builder 插件。

插件介绍

面对陌生或快速演进的代码库,人类和模型都需要一份“能读、能验、还能跟上变化”的项目文档,而不是散落在对话里、无法核对的口头总结。proj-doc-builder 的定位,是把源代码树整理成结构化 Markdown 大纲——每个源目录对应一份文档,写明文件清单、关键符号、依赖与在系统中的角色,让后续阅读有据可依。

它的硬核在于“增量与可证”:用内容哈希和清单记住上一次扫描到的树长什么样,下一轮只对实际改动的目录动手;发布走可恢复的事务流程,停用文档需要明确依据,而不是静默清扫。工具写出的清单是“是否在同步”的客观证据,与写出正文的产者彼此分离,避免“模型自称已同步”却无法证伪。

仓库内还提供加载器:先校验清单与磁盘上的文档一致,再按需提供概览、单篇或单节,避免把过期索引喂给会话。适合希望为 Agent 工作流或团队长期维护一套可与代码对账、可增量更新、且发布行为可审计的项目文档的人使用;你也需要接受项目侧对 project_docs、CLAUDE.md 等约定的前置布局。

使用场景

  • 需要快速摸清陌生仓库并为会话提供可对账的项目地图时。
  • 希望仅对改动的源目录重写文章、清单证明文档与代码同步时。
  • 要在加载前校验清单与 Markdown,避免把过期索引导入会话时。

适合人员

  • 在 DeepSeek Harness 中挂载捆绑技能、面向代理工作流的开发者。
  • 需要可审计、可增量更新的项目文档与发布语义的责任人或维护者。
  • 希望用 Python 3.12+ 标准库 CLI、无第三方运行时依赖也能生成文档的人。