前言¶
在 DeepSeek Harness(DSH)里让智能体写需求、设计或计划类文档时,常见做法是直接生成 Markdown 或自由格式文本,事后很难用同一套规则复检,多阶段产物之间也缺少可机器核对的衔接。若希望「一种文档类型对应一份 JSON Schema 与规则集、生成失败可自动修稿、每份产物附带可重放的校验回执」,需要在 Harness 侧有专门的文档生成与校验能力。下面介绍社区插件 @sharework-ai/dsh-docwright(GitHub:sharework-ai/dsh-docwright),由 sharework-ai 维护,当前 npm 包版本为 0.4.2,许可证 MIT。
这是什么¶
docwright 是面向 deepseek-harness 的文档生成插件:以 JSON 为唯一事实来源;每个 pack 定义一种文档类型(JSON Schema、校验规则、生成提示词);多个 pack 可串联成多阶段场景;可调参数在生成前经确认门(confirmation gate);每份文档附带可复验的校验回执(receipt);插件还 bundled 一份 skill,用于指导智能体编写新的 pack。
核心功能¶
Pack 与工具面¶
doc_packs:无参发现工具,列出已安装的 pack,返回名称、版本、描述、语言、consumes、以及 pack 声明的可调参数(含required/confirm/overridable/extractable等标志)。在选用未知 pack 时,错误信息也会指向此工具。doc_generate:按 pack 生成文档,支持材料路径、语言、上游产物、topic 目录、params/confirm、复用与force等;校验不通过时将失败反馈给模型修稿,直至规则全部通过或达到轮次上限(耗尽时仍保留草稿与标红的回执)。返回artifactPath、markdownPath、receipt。doc_extract_params:对标记为extractable: true的参数,从材料中提取{ value, quote }(quote 须为材料原文摘录,引擎可验证)或{ notFound: true };结果持久化为<pack>.extracted.json,供后续doc_generate复验。doc_validate:对已存在产物重跑规则集,确定性、不调用 LLM;绿色校验可重新签发(seal)侧车回执;若侧车回执与当前安装的 pack 版本不一致,结果会标记packVersionStale,提示按新规则重新生成。
链式场景(如 cosmic 系列的 plan / req / func / tech)在 README 中另有 topic、upstream、按函数 fan-out 与 doc_chain_status 等约定,细节见仓库内设计文档。
校验与复用¶
生成物须通过 pack 的 JSON Schema 与规则集;每次校验产生机器可读回执,任何人可按回执重放验证。具备 reuse 的 pack 在输入材料哈希、上游锚点等与已有绿色产物一致时可直接复用(零 LLM);人工编辑后哈希变化,经 doc_validate 密封后可重新进入链路。
安装与启用¶
安装命令以 README Quickstart 为准:
dsh plugin add @sharework-ai/dsh-docwright # 安装到当前 profile
dsh # 使用该 profile 启动会话
package.json 声明 Node 引擎为 ^22.19.0 || >=24.0.0,并依赖 DSH 生态中的 @deepseek-ai/cordis、@deepseek-ai/dsh-llm、@deepseek-ai/dsh-tools 等 peer 依赖;实际环境需与所用 DSH 版本匹配。
典型用法¶
README 提供约两分钟、无需 API Key 的确定性首跑:将 bundled 示例复制到工作区后,在会话中校验 golden sample:
> doc_validate(artifactPath: "sample.json", pack: "cosmic-plan")
# sample.json 为对应 pack 自带的 golden sample,需先复制到工作区
数秒内应得到全绿回执,且不调用 LLM;这是确定性第一步,闭环生成 doc_generate 为第二步。
发现可用 pack 时,可先调用 doc_packs,再按 pack 说明准备 references/ 材料、必要时先 doc_extract_params,最后 doc_generate 并在参数变更时完成用户确认(confirm)。
适用场景与注意¶
适合需要在 DSH 会话中产出结构化 JSON 文档、并要用同一套 schema 与规则反复校验或串联多阶段交付物的团队与插件作者。若只需一次性 prose,不必引入 pack 与回执链路。
插件随 DSH 进程权限访问工作区与配置;安装前应阅读 GitHub 仓库 源码与 MIT 许可证,确认 pack 与材料路径符合你的安全策略。DSH 社区插件目录托管于独立站点(如 SkillHub 上的 dsh-docwright 页),与 DeepSeek / 幻方无官方从属关系。
结尾¶
docwright 把「文档类型定义、生成、校验修稿、参数确认、可复验回执」收进一套 pack 模型,并支持链式场景与 pack authoring skill。目录页:https://www.skillhub.cn/plugins/sharework-ai/dsh-docwright;源码与完整工具说明:https://github.com/sharework-ai/dsh-docwright。