2.2 KiB
Agent Note: 以产品为先的根 README
Status: implemented
English | 中文
问题
根 README 是评估 DeepSeek Harness 的读者最先看到的页面,但以 SDK 为先的贡献者信息会挤占从产品定位直达安装与启动的最短路径。详尽的包(package)清单、架构图、演示以及重复的技术说明,也比其描述的接口更快失效。
决策
根 README 首先将 DeepSeek Harness 呈现为一款可安装的 coding agent(编程智能体)。它说明产品基于 SDK,保留受支持的单行安装命令,并将 Web UI、TUI 和 Headless 入口置于架构与贡献者资料之前。
功能概览保持简洁:它说明常见的内置编程功能,突出插件扩展性这一差异化设计,并明确 Code Mode 和自指 Cordis 工具都需显式启用。详细契约留在各自的权威文档中;根 README 只提供链接,不复制内容。
中英文 README 采用相同的产品、安装、功能、开发和许可证结构。社区章节则有意采用各语言读者的主要渠道:英文版指向 Twitter,中文版提供微信社区二维码。二维码是 README 中唯一保留的媒体,因为它是实际入口,而非产品装饰。
备选方案
保留以 SDK 为先的贡献者 README。 这能让读者立即看到仓库架构,却延后了“产品是什么、如何运行”这两个答案。贡献者仍可通过开发与架构链接获得所需指引。
采用包含徽章、截图、架构图、包清单和教程的完整营销页面。 这会让落地页承载更多材料,却会重复易变事实,并在产品接口稳定前增加媒体维护工作。
两种语言采用同一个社区渠道。 渠道完全对称更简单,但当两种语言的读者聚集在不同平台时,这种做法实用性更低。技术内容保持配对,社区目的地则按读者群体选择。
影响
新读者可以快速进入可运行的界面,并通过稳定链接了解更深入的 SDK 细节。根 README 足够精简,可在安装器或 CLI 接口变化时及时更新。在富媒体、包清单和长篇教程拥有持久的负责方与维护路径之前,它们不进入这个产品入口。