前言¶
在 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。