dsh-project-handbook:DeepSeek Harness 項目交接手冊生成器

前言

在 DeepSeek Harness (DSH) 的開發流程中,項目交接文檔往往依賴過時的 README 或口頭傳遞,導致新入職工程師上手緩慢,且關鍵信息容易丟失。dsh-project-handbook 旨在通過自動化掃描和結構化模板,將倉庫轉化爲一套證據確鑿、可直接執行的項目交接與入職手冊。

插件簡介

這是一個公司級項目交接與入職手冊生成器,由 Gan-lang 維護,遵循 MIT 許可證。它通過確定性倉庫掃描和文檔質量門禁,確保生成的文檔包含事實依據而非推測,並支持多種技術棧。

核心功能

該插件提供以下核心能力:
1. 文檔生成:自動生成包含 15 個部分的項目交接文檔、入職清單、術語表和運行手冊。
2. 倉庫偵察:執行確定性掃描,識別編程語言、manifests、框架信號、CI 作業、部署工件、環境變量、遷移腳本、測試佈局、Git 歷史及技術債務標記。
3. 堆棧感知:針對 Java/Spring、Go、Python、Node/TypeScript、前端、數據/AI 及遺留運維項目提供特定的偵察劇本。
4. 質量門禁:檢查文檔完整性、佔位符填充、引用路徑有效性、腳本定義匹配度、敏感信息泄露及與事實庫的衝突。
5. 安全模式:採用只讀偵察模式,不執行構建、遷移或部署,確保安全。

安裝與啓用

通過 DeepSeek Harness 的插件管理工具安裝:

dsh plugin --profile web add github:Gan-lang/dsh-project-handbook

安裝後,需在 $DSH_HOME/profiles/web/package.json 的 bundle 列表中添加該插件,並重啓 dsh web。

使用方法

交互式使用:
在任意會話中直接詢問模型:

生成這個項目的交接文檔,要公司項目級、新人能直接上手的那種

腳本獨立運行:
插件包含的腳本也可以在本地 Node.js 環境中獨立運行。

  1. 倉庫偵察:
node skills/project-handbook/scripts/project-inventory.mjs --root . --out .handover/inventory.json
  1. 文檔質量門禁檢查:
node skills/project-handbook/scripts/check-handbook.mjs .handover/PROJECT-HANDBOOK.md \
  --root . \
  --facts .handover/inventory.json \
  --profile standard \
  --report .handover/check-report.md

輸出結構

掃描完成後,會在 .handover/ 目錄下生成以下文件:
- PROJECT-HANDBOOK.md:15 部分項目交接手冊。
- ONBOARDING-CHECKLIST.md:入職首日/首周清單。
- GLOSSARY.md:領域及內部術語表。
- RUNBOOK.md:故障卡片、發佈流程、數據修復指南。
- inventory.json / .md:所有聲明的證據庫。
- check-report.md:質量門禁檢查報告。

系統要求與限制

  • 環境要求:Node.js 版本需爲 ^22.19.0 || >=24.0.0,無運行時依賴。
  • DSH 依賴:DSH 主機需提供 @deepseek-ai/dsh-skill-filesystem 技能。
  • 運行模式:僅支持只讀偵察,腳本不可執行構建、遷移或部署操作。

總結

dsh-project-handbook 將項目交接從“文檔撰寫”轉變爲“倉庫事實提取與驗證”,幫助團隊建立可維護、可審計的技術知識庫。

羽毛球分组比赛记分
小程序二维码

欢迎使用《羽毛球分组比赛记分》微信小程序

小夜