jackyu66gitandCursor
2fb1dfee14
Archive the differentiated YuXinGu product docs, AI engineering system, design contract, and Go/Vue scaffold. Next execution prioritizes Cece-parity over early innovation (see .ai/product/STRATEGY.md). Co-authored-by: Cursor <cursoragent@cursor.com>
27 lines
857 B
Markdown
27 lines
857 B
Markdown
# 12 文档规范
|
||
|
||
> **工程协作规则已迁至** [`.ai/`](../../../.ai/)。本文件仅作产品文档索引补充；标准正文勿再扩写于此。
|
||
|
||
## 类型
|
||
|
||
| 类型 | 位置 |
|
||
|---|---|
|
||
| 索引 | `apps/docs/README.md` |
|
||
| 竞品分析 | `apps/docs/analysis/*` |
|
||
| PRD | `apps/docs/prd-mvp.md` |
|
||
| 商业模式 | `apps/docs/business-model.md` |
|
||
| 产品路线图 | `apps/docs/product-roadmap.md` |
|
||
| ADR（架构决策） | `apps/docs/adr/` 与 `.ai/adr/` |
|
||
| API | `proto/openapi.yaml` |
|
||
| 工程标准 | `.ai/*`（勿继续写 `apps/docs/standards/*`） |
|
||
| 变更 | `apps/docs/CHANGELOG.md`（可选） |
|
||
|
||
## ADR
|
||
|
||
重大选型（库、支付渠道、LLM 供应商）必须写 ADR：背景、决策、后果。
|
||
|
||
## 文风
|
||
|
||
- 中文产品文档；英文可出现在代码标识符与 Commit。
|
||
- 避免过时截图；以路径与接口为准。
|