Skip to content

Latest commit

 

History

History
28 lines (21 loc) · 1.44 KB

File metadata and controls

28 lines (21 loc) · 1.44 KB

baipiao 文档索引

这个页面是项目文档入口。新用户从上往下读;实现者按主题跳转。

产品与设计

文档 用途
PRD 产品范围、用户故事、命令总表、MCP tools、数据模型、Definition of Done
README 落地页、快速开始、核心能力、演示图、安装入口
落地页与文档站设计 首页、文档站、多语言、设计系统、中文设计稿资产
CLI 四面板设计稿 initsearchsetupstatus 的终端体验基准

架构与接口

文档 用途
技术架构 CLI Presentation、Core、MCP Server、数据流、包结构
API / Vault / MCP CLI、MCP、Vault、Env、错误码、安全边界
数据源、Normalize、Prompt 与 MCP 流程 free-for-dev 获取、normalized schema、prompt 生成、MCP 调用链路

最短阅读路径

  1. 产品负责人:先读 README,再读 PRD
  2. 实现者:先读 技术架构,再读 API / Vault / MCP
  3. 做数据源:读 数据源流程
  4. 做 MCP:读 API / Vault / MCP
  5. 做官网/文档站:读 落地页与文档站设计