Skip to main content
B

dsh-doc-master

ben8804/dsh-doc-master

DSH 文档管理插件:变更日志管理、模块摘要管理、文档优先查询模式,以及结构化代码分析引擎。

Install

dsh plugin --profile web add github:ben8804/dsh-doc-master

README

dsh-doc-master

DeepSeek Harness 文档管理插件,用于解决大型(前后端分离)项目中 Agent 重复读取全量代码的问题。

能力

  • /changelog(工具 docmaster_changelog):每次代码修改后生成/追加结构化 CHANGELOG 条目,倒序写入 CHANGELOG.md
  • /module(工具 docmaster_module):为指定模块生成/增量更新摘要到 docs/modules/<name>.md(职责、接口、依赖、关键文件)。
  • /doc-first / /doc-off(工具 docmaster_doc_first / docmaster_doc_off):开启/关闭“文档优先”模式,模式开启时会向模型提示注入「先查 CHANGELOG 与模块摘要,文档不足才读代码」的流程。
  • analyze-code(工具 docmaster_analyze_code):结构化代码分析引擎(TypeScript/JavaScript/Python),返回主要导出、方法签名、外部依赖、文件清单(JSON)。
  • /doc-config(工具 docmaster_config):查看/修改/重置 .doc-master.json

配置

插件首次运行时会在项目根目录生成 .doc-master.json

{
  "changelog": { "path": "CHANGELOG.md", "maxEntries": 100, "template": "custom" },
  "modules": { "path": "docs/modules/", "autoAnalyze": true, "exclude": ["node_modules", "dist", "__pycache__", ".git"] },
  "docFirst": { "enabledByDefault": false, "fallbackToCode": true }
}

实现说明

  • 入口 lib/index.js 为可直接加载的 ESM JavaScript(无构建步骤)。核心依赖 @deepseek-ai/cordis@deepseek-ai/dsh-tools 作为 peerDependencies 提供。
  • 代码分析采用结构化词法扫描(注释/字符串掩码 + 声明扫描),识别 import/require、export(default/命名)、function/class/interface/type/enum/const 以及 Python 的 import/def/class 与常量,无需额外 AST 库依赖。

安装

# 从 npm 安装(推荐,走 tarball 更快)
dsh plugin --profile web add dsh-doc-master

# 或直接从 GitHub 安装(未发布 npm 时)
dsh plugin --profile web add github:ben8804/dsh-doc-master

安装后(也可在设置 → 插件市场里一键安装),重启 DSH 进程使新 bundle 生效。

Related plugins