DeployLite 是一个虚构但完整的开源项目设定:一个轻量级、自托管的持续集成与部署平台,面向中小团队与独立开发者,目标是用最小成本跑通从代码提交到上线的完整生命周期。这个目录里的 18 篇文档不是泛泛的产品介绍,而是一套「如果真要做,文档长什么样」的模板集:商业计划书回答为什么做,白皮书回答技术上怎么站得住,十章 PRD 回答做什么与怎么验收,工程手册回答怎么实现,品牌文档回答对外怎么讲。适合正在评估自建部署平台的团队,也适合把 PRD 写作当作学习对象的产品经理。
专题速览
| 维度 | 说明 |
|---|---|
| 文档规模 | 18 篇直接文章,全部位于本目录,无子目录 |
| 时间跨度 | 全部集中于 2025-10-23,一天内成体系产出 |
| 文档类型 | 商业计划、技术白皮书、功能清单、十章 PRD、架构文档、工程手册、品牌文档 |
| 难度分布 | 商业与品牌偏认知,PRD 与工程手册偏技术 |
| 目标读者 | 平台工程师、DevOps、独立开发者、产品经理 |
| 核心价值 | 一套可直接借鉴的「从 0 写一个平台产品文档」的完整范例 |
商业与战略基础
这一组回答「为什么值得做一个自托管部署平台」。商业计划书给出项目概述、时代机遇与商业模式,技术白皮书确立技术立场,功能与特性清单把能力边界一次说清。三篇连读可以在半小时内建立对项目的完整认知。
| 文章 | 核心内容 |
|---|---|
| 「DeployLite」商业计划书 | 从项目概述、时代机遇到核心功能、技术架构与商业模式的完整规划 |
| 「DeployLite」技术白皮书 | 定义自托管 CI/CD 平台的技术定位与轻量化路线 |
| 「DeployLite」功能与特性清单 | 逐项列出平台功能与特性边界,作为后续 PRD 的索引 |
PRD 十章:从产品概述到附录
这是本目录的主体。十章 PRD 按标准产品文档结构推进:先讲产品概述与背景,再讲总体架构,然后依次覆盖核心功能、进阶能力、非功能性需求、交互设计、技术实现与接口、验收标准、版本规划,最后以附录收尾。每一章都是可独立阅读的完整章节,也可以当作写作模板直接套用。
| 文章 | 核心内容 |
|---|---|
| 「DeployLite」目录:轻量级打包与部署平台 PRD | PRD 全篇导航,说明十章的组织逻辑与阅读顺序 |
| 「DeployLite」第一章:产品概述与背景 | 交代产品要解决的问题、目标用户与立项背景 |
| 「DeployLite」第二章:总体架构与系统设计 | 拆解控制层、执行层、存储层、监控层的组件划分 |
| 「DeployLite」第三章:核心功能需求 | 定义流水线、构建、部署、环境管理等核心功能需求 |
| 「DeployLite」第四章:进阶功能与策略化能力 | 覆盖 YAML Pipeline、多环境部署、审批流程与插件系统 |
| 「DeployLite」第五章:非功能性需求与运维保障 | 给出性能、可用性、安全与运维保障的量化要求 |
| 「DeployLite」第六章:交互原型与用户体验设计 | 覆盖信息架构、页面层级、组件设计与交互流程 |
| 「DeployLite」第七章:技术实现与接口设计 | 覆盖技术栈总览、数据库设计、API 规范与安全考虑 |
| 「DeployLite」第八章:验收标准与测试计划 | 定义功能、性能与安全的验收标准与测试范围 |
| 「DeployLite」第九章:版本规划与迭代路线 | 给出产品演进逻辑、版本分期与功能迭代计划 |
| 「DeployLite」第十章:附录 | 收纳术语表、参考资料与补充说明 |
架构与工程实现
PRD 之后是「怎么做」。系统架构白皮书从组件、数据流与安全机制三个角度把架构再讲一遍,偏重设计决策;工程实现手册则落到模块划分、接口设计与数据存储的实现细节,偏重可操作性。两篇互补,建议先读白皮书建立结构感,再读手册看落地细节。
| 文章 | 核心内容 |
|---|---|
| 「DeployLite」系统架构白皮书 | 从组件架构、数据流程与安全机制阐述系统设计决策 |
| 「DeployLite」技术实现详解(工程手册) | 落到模块划分、接口设计与数据存储的实现级细节 |
项目起源与品牌叙事
文档集最后补上了两块常被忽略的内容:项目是怎么开始的,以及对外应该怎么讲。起源篇用叙事方式交代动机,品牌篇给出品牌基因、人格语调、视觉识别与叙事框架。对于想做开源项目的团队,这两篇是「技术之外」的必备补充。
| 文章 | 核心内容 |
|---|---|
| 「DeployLite」梦开始的地方 | 以叙事方式交代项目起源与最初的问题意识 |
| 「DeployLite」品牌视觉与叙事白皮书 | 覆盖品牌基因、人格语调、视觉识别系统与叙事框架 |
推荐阅读路径
技术负责人评估「要不要自建部署平台」:
- 先读商业计划书与技术白皮书,判断方向是否匹配团队现状。
- 读总体架构与系统设计与系统架构白皮书,评估工程复杂度。
- 用非功能性需求与运维保障对照团队当前的运维能力。
产品经理学习 PRD 写作:
开源项目发起人:
- 读梦开始的地方与品牌视觉与叙事白皮书,想清楚对外怎么讲。
- 结合功能与特性清单确定第一版范围。
文档之间的引用关系
这套文档不是互相独立的散篇,读的时候如果注意它们之间的引用,会发现一条清晰的主线。
商业计划书是源头,它给出项目定位与商业模式,技术白皮书和功能清单都从这里派生。功能清单是 PRD 的索引:PRD 第三章的每一项核心功能需求,几乎都能在功能清单里找到对应条目,而功能清单里的边界描述又反过来约束 PRD 的验收标准。
PRD 内部也有依赖。第二章的总体架构决定了第七章技术实现与接口设计的自由度;第三章的核心功能需求与第四章的进阶功能是「先做与后做」的关系,而不是并列关系;第八章验收标准和第九章版本规划互为镜像,前者定义什么叫做完,后者定义什么时候做完。
架构白皮书与工程手册是 PRD 的横向补充。PRD 里的架构章节偏「产品视角的组件划分」,架构白皮书偏「工程视角的设计决策」,工程手册则把决策落成模块与接口。三份文档对同一件事的描述粒度不同,交叉阅读可以避免只看一层造成的误解。
常见使用误区
第一个误区是把 PRD 当需求清单直接开工。这套 PRD 的写法更接近设计文档,它花大量篇幅解释为什么这样设计,而不是只列功能点。如果只挑功能点做,会丢掉取舍理由,后面遇到冲突时无从判断。
第二个误区是跳过白皮书直接读工程手册。手册里的模块划分依赖白皮书里的架构决策,脱离架构读实现细节,容易觉得「为什么这么设计」莫名其妙。
第三个误区是把品牌文档当装饰。品牌叙事框架其实和定位、文案、Demo 话术直接相关,早期团队如果只写技术文档不写品牌,对外表达会长期不一致。
第四个误区是忽略附录与术语表。CI/CD 领域的术语在不同团队里含义不完全相同,第十章附录的价值在于把口径固定下来,减少沟通成本。
文档配套清单
把 18 篇文档按用途归类,可以在不同场景下快速定位该带哪一份出门。
- 对外沟通与融资:商业计划书、品牌视觉与叙事白皮书
- 技术选型与架构评审:技术白皮书、第二章总体架构、系统架构白皮书
- 需求评审与排期:PRD 目录、第三章核心功能需求、第九章版本规划
- 开发实现:第七章技术实现与接口设计、工程实现手册
- 测试与验收:第五章非功能性需求、第八章验收标准与测试计划
- 交互与前端:第六章交互原型与用户体验设计
- 团队 onboarding:梦开始的地方、第一章产品概述与背景、第十章附录
- 能力边界确认:功能与特性清单、第四章进阶功能与策略化能力
- 竞品对照:商业计划书与功能清单结合,明确不做什么
- 迭代复盘:第九章版本规划与工程手册,对照实际交付进度
- 新人答疑:第十章附录的术语表,统一团队内部口径
相关专题
- SaaS 专题总入口:本目录所属的 SaaS 大专题,含行业趋势与开发方法论。
- AI 开发者工具平台专题导航:同为「平台产品从 0 到 1」的完整文档集,可对照阅读。
- Webhook 专题导航:涉及事件推送与平台设计,与 CI/CD 的触发机制相通。
- SaaS Starter 专题导航:SaaS 创业方法论合集,补充产品与商业视角。
- 短链接服务专题导航:另一个轻量级自托管服务的完整设计案例。