Chuyển đến nội dung chính

dsh-docforge

Đã xác minh

dsh-docforge · v0.0.1 · MIT

Documentation generation for DeepSeek Harness: from codebase to living docs

Cài đặt

dsh plugin add dsh-docforge

Xác nhận layer đã áp bằng dsh --profile default --dump-config — xem hướng dẫn cài plugin.

Mã nguồn

Phát hành lên npm mà không có repository công khai. Hãy kiểm tra nội dung package trước khi cài.

Thẻ

Readme

dsh-docforge

Documentation generation for DeepSeek Harness: from codebase to living docs

A DeepSeek Harness (dsh) plugin.

Why

从代码库生成"活的"文档。文档渲染赛道玩家极少但天花板极高(同类插件 archify 已验证 14k 热度)。

Business scenarios

  • 架构评审:评审时让 agent 把口头决策固化成 ADR 归档
  • 新人上手:从目录结构生成模块导读骨架

What works in 0.0.1

This is a working plugin, not a name reservation:

  • docgen_adr 工具:按字段(标题、背景、决策、后果、状态)生成标准 Architecture Decision Record 文档。技术决策从此有迹可循

Install it and ask the agent to call the tool — the loop (tool registration, schema validation, model invocation, structured output) is fully exercised.

Roadmap

  • 0.1.x — 模块级文档:按目录结构生成 API/架构文档(Markdown 原生)
  • 0.2.x — 图表渲染:架构图、时序图、数据流图(自包含 HTML)
  • 0.3.x — 漂移检测:代码变更后标记过期文档

Install

dsh plugin --profile web add dsh-docforge

DeepSeek Harness is in developer preview and states that compatibility-breaking changes will happen. This build was developed and tested against @deepseek-ai/dsh 0.1.0-rc.x (August 2026); re-verify against your host version before relying on it.

License

MIT