dsh-sdd-generator
其他 活跃维护

dsh-sdd-generator

tblong2105/dsh-sdd-generator

轻量级代码文档生成插件,可自动扫描目标代码库的结构与依赖关系,直接输出符合规范的软件设计文档(SDD)大纲,省去手动梳理架构逻辑的步骤,快速搭建文档框架。

0
Stars 标星
0
Forks 分支
0
Watchers 关注
0
Open Issues
JavaScript
主要语言
None
开源协议
3 KB
仓库大小
1 个月前
最后推送
一键安装扩展 / 插件指令
dsh plugin --profile web add github:tblong2105/dsh-sdd-generator
git clone https://github.com/tblong2105/dsh-sdd-generator.git
git clone git@github.com:tblong2105/dsh-sdd-generator.git
README.md main

dsh-sdd-generator

A DeepSeek Harness plugin that scans a
codebase and generates a Software Design Document (SDD) outline — module inventory,
entry points, and a per-file summary.

Install

dsh plugin --profile web add dsh-sdd-generator

The plugin auto-mounts via its dsh.bundle.patch declaration (no manual cordis.patch.yml
editing needed). Restart dsh web afterwards.

Use

In the chat, ask the model to generate an SDD, e.g.:

"Generate an SDD for C:\Users\me\projects\my-app using the generate_sdd tool"

The model calls the generate_sdd tool with:

param type description
root string Absolute path to the codebase root to scan
maxFiles number Cap on files scanned (default 200, max 500)

The tool returns a Markdown SDD skeleton that the model can then expand into a full document.

Develop

This package ships plain JS (lib/index.js) so no build step is required for consumers.

npm publish        # publish to npm, then others can `dsh plugin add` it

Add the dsh-plugin topic to the GitHub repo to appear in community listings.

License

MIT