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 环境中独立运行。

仓库侦察：

node skills/project-handbook/scripts/project-inventory.mjs --root . --out .handover/inventory.json

文档质量门禁检查：

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 将项目交接从“文档撰写”转变为“仓库事实提取与验证”，帮助团队建立可维护、可审计的技术知识库。