dsh-plugin-auto-docs
在终端中运行以下命令:
dsh plugin install YYTbit/dsh-plugin-auto-docs
将以下提示词粘贴到 DeepSeek Harness 对话框中:
在 DeepSeek Harness 中执行 dsh plugin install YYTbit/dsh-plugin-auto-docs 即可安装,完整源码地址:https://github.com/YYTbit/dsh-plugin-auto-docs
插件介绍
写代码时大家都想快点交付,可文档这件事往往一拖再拖。项目结构已经搭好、函数签名也定下来了,唯独 README 和 API 说明还是一片空白。dsh-plugin-auto-docs 正是为这个痛点而生:它教会 DeepSeek Harness 代理按照项目上下文自动生成文档,省去从零敲字的重复劳动。
插件覆盖四类常见文档场景。一是根据目录与文件结构直接写出 README 骨架;二是读取函数与类的方法签名,生成结构化的 API 参考文档;三是从 Git 提交历史中提取变更,拼装成规范的 Changelog;四是为导出的函数自动补上 JSDoc 内联注释,让 IDE 悬停提示立刻可用。
它特别适合小型开源项目、刚起步的内部工具库,以及希望在发版前快速补齐文档的团队。不需要预先准备模板或手动对齐格式,一句话指令就能让代理把文档从草稿推到可发布状态,把精力留给真正的设计与实现。
使用场景
- 新项目脚手架搭好后快速生成 README 骨架
- 发版前根据 Git 提交历史自动拼装 Changelog
- 为已有代码库批量补全 JSDoc 内联注释
适合人员
- 需要持续维护文档的小型开源项目作者
- 希望减少重复文档工作的独立开发者
- 发版前需快速补齐 API 文档的技术团队